Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
OnReceive Method
See Also  Example
Leadtools.Dicom Namespace > DicomNet Class : OnReceive Method



error
An error code.
pduType
The type of data that was sent.
buffer
Pointer to a buffer that contains all the data that was sent. This includes the Command Set and any associated Data Set.
bytes
The number of bytes of the data specified by buffer.
error
An error code.
pduType
The type of data that was sent.
buffer
Pointer to a buffer that contains all the data that was sent. This includes the Command Set and any associated Data Set.
bytes
The number of bytes of the data specified by buffer.
Notifies a connection that data was received.

Syntax

Visual Basic (Declaration) 
Protected Overridable Sub OnReceive( _
   ByVal error As DicomExceptionCode, _
   ByVal pduType As DicomPduType, _
   ByVal buffer As IntPtr, _
   ByVal bytes As Integer _
)
Visual Basic (Usage)Copy Code
Dim instance As DicomNet
Dim error As DicomExceptionCode
Dim pduType As DicomPduType
Dim buffer As IntPtr
Dim bytes As Integer
 
instance.OnReceive(error, pduType, buffer, bytes)
C# 
protected virtual void OnReceive( 
   DicomExceptionCode error,
   DicomPduType pduType,
   IntPtr buffer,
   int bytes
)
C++/CLI 
protected:
virtual void OnReceive( 
   DicomExceptionCode error,
   DicomPduType pduType,
   IntPtr buffer,
   int bytes
)

Parameters

error
An error code.
pduType
The type of data that was sent.
buffer
Pointer to a buffer that contains all the data that was sent. This includes the Command Set and any associated Data Set.
bytes
The number of bytes of the data specified by buffer.

Example

This is a comprehensive sample that shows how to process a DICOM C-Store operation on both the SCP (server) and the SCU (client) sides.

Visual BasicCopy Code
<StructLayout(LayoutKind.Sequential)> _
Public Structure MSG
    Public hwnd As IntPtr
    Public message As UInteger
    Public wParam As IntPtr
    Public lParam As IntPtr
    Public time As UInteger
    Public p As System.Drawing.Point
End Structure
Public Enum WaitReturn
    Complete
    Timeout
End Enum

Private Class Utils
    <DllImport("user32.dll")> _
    Shared Function PeekMessage(<System.Runtime.InteropServices.Out()> ByRef lpMsg As MSG, ByVal hWnd As IntPtr, ByVal wMsgFilterMin As UInteger, ByVal wMsgFilterMax As UInteger, ByVal wRemoveMsg As UInteger) As <MarshalAs(UnmanagedType.Bool)> Boolean
    End Function

    <DllImport("user32.dll")> _
    Shared Function TranslateMessage(ByRef lpMsg As MSG) As Boolean
    End Function
    <DllImport("user32.dll")> _
    Shared Function DispatchMessage(ByRef lpmsg As MSG) As IntPtr
    End Function

    Private Const PM_REMOVE As UInteger = 1

    Public Shared Function WaitForComplete(ByVal mill As Double, ByVal wh As WaitHandle) As WaitReturn
        Dim goal As TimeSpan = New TimeSpan(DateTime.Now.AddMilliseconds(mill).Ticks)

        Do
            Dim msg As MSG = New MSG()

            If PeekMessage(msg, IntPtr.Zero, 0, 0, PM_REMOVE) Then
                TranslateMessage(msg)
                DispatchMessage(msg)
            End If

            If wh.WaitOne(New TimeSpan(0, 0, 0), False) Then
                Return WaitReturn.Complete
            End If

            If goal.CompareTo(New TimeSpan(DateTime.Now.Ticks)) < 0 Then
                Return WaitReturn.Timeout
            End If

        Loop While True
    End Function
End Class

Private Class Client : Inherits DicomNet
    Private _LastError As DicomExceptionCode = DicomExceptionCode.Success
    Private waitEvent As AutoResetEvent = New AutoResetEvent(False)

    Public Sub New()
        MyBase.New(Nothing, DicomNetSecurityeMode.None)
    End Sub

    Public ReadOnly Property LastError() As DicomExceptionCode
        Get
            Return _LastError
        End Get
    End Property

    Public Function Wait() As Boolean
        Dim ret As WaitReturn

        _LastError = DicomExceptionCode.Success
        ret = Utils.WaitForComplete((5 * 60) * 1000, waitEvent)

        Return (ret = WaitReturn.Complete)
    End Function

    Protected Overrides Sub OnConnect(ByVal [error] As DicomExceptionCode)
        _LastError = [error]
        waitEvent.Set()
    End Sub

    Protected Overrides Sub OnReceiveAssociateAccept(ByVal association As DicomAssociate)
        waitEvent.Set()
    End Sub

    Protected Overrides Sub OnReceiveCStoreResponse(ByVal presentationID As Byte, ByVal messageID As Integer, ByVal affectedClass As String, ByVal instance As String, ByVal status As DicomCommandStatusType)
        Debug.Assert(status = DicomCommandStatusType.Success, "Status should be success")
        waitEvent.Set()
    End Sub
End Class

Private Class ServerConnection : Inherits DicomNet
    Public Sub New()
        MyBase.New(Nothing, DicomNetSecurityeMode.None)
    End Sub

    Protected Overrides Sub OnReceiveAssociateRequest(ByVal association As DicomAssociate)
        Dim retAssociation As DicomAssociate = New DicomAssociate(False)

        Debug.Assert(association.Called = "ServerTest", "Called AETitle should be ServerTest")
        Debug.Assert(association.Calling = "ClientTest", "Calling AETitle should be ClientTest")
        Debug.Assert(association.ImplementClass = "1.2.840.114257.1", "Implementation class should be 1.2.840.114257.1")
        Debug.Assert(association.ImplementationVersionName = "1", "Implementation version should be 1")
        Debug.Assert(association.MaxLength = &H100000, "Max length should be 0x100000")
        Debug.Assert(association.GetAbstract(1) = DicomUidType.VerificationClass, "Presentation index 1 should be " & DicomUidType.VerificationClass)
        Debug.Assert(association.GetTransfer(1, 0) = DicomUidType.ImplicitVRLittleEndian, "Abstract Syntax (1,0) should be " & DicomUidType.ImplicitVRLittleEndian)

        '
        ' Build our Association Accept
        '
        retAssociation.Called = association.Called
        retAssociation.Calling = association.Calling
        retAssociation.ImplementClass = association.ImplementClass
        retAssociation.ImplementationVersionName = association.ImplementationVersionName
        Dim x As Integer = 0
        Do While x < association.PresentationContextCount
            Dim id As Byte = association.GetPresentationContextID(x)
            Dim abSyntax As String = association.GetAbstract(id)
            Dim trSyntax As String = DicomUidType.ImplicitVRLittleEndian

            retAssociation.AddPresentationContext(id, 0, abSyntax)
            If association.GetTransferCount(id) > 0 Then
                trSyntax = association.GetTransfer(id, 0)
            End If

            retAssociation.AddTransfer(id, trSyntax)
            x += 1
        Loop
        SendAssociateAccept(retAssociation)
    End Sub

    Protected Overrides Sub OnReceiveCStoreRequest(ByVal presentationID As Byte, ByVal messageID As Integer, ByVal affectedClass As String, ByVal instance As String, ByVal priority As DicomCommandPriorityType, ByVal moveAE As String, ByVal moveMessageID As Integer, ByVal dataSet As DicomDataSet)
        Dim id As Byte = Association.FindAbstract(affectedClass)

        Debug.Assert(id = presentationID, "PresentationID is invalid")
        Debug.Assert(messageID = 2, "Invalid message id. Should be 2")
        Debug.Assert(Not dataSet Is Nothing, "Dataset should not be null")
        Debug.Assert(moveAE = "NONE", "Move AE should be NONE")
        Debug.Assert(moveMessageID = 1, "Move message id should be 1")
        Debug.Assert(priority = DicomCommandPriorityType.Medium, "Priority should be medium")

        SendCStoreResponse(presentationID, messageID, affectedClass, instance, DicomCommandStatusType.Success)
    End Sub
    Protected Overrides Sub OnReceive(ByVal [error] As DicomExceptionCode, ByVal pduType As DicomPduType, ByVal buffer As System.IntPtr, ByVal bytes As Integer)
       MyBase.OnReceive([error], pduType, buffer, bytes)
    End Sub

    Protected Overrides Sub OnSend(ByVal [error] As DicomExceptionCode, ByVal type As DicomPduType, ByVal length As Integer)
    MyBase.OnSend([error], type, length)
    End Sub

End Class

Private Class Server : Inherits DicomNet
    Private client As ServerConnection

    Public Sub New()
        MyBase.New(Nothing, DicomNetSecurityeMode.None)
    End Sub

    Protected Overrides Sub OnAccept(ByVal [error] As DicomExceptionCode)
        client = New ServerConnection()

        Accept(client)
    End Sub
End Class


<Test> _
Public Sub SendCStoreRequestSample()
    DicomEngine.Startup()
    DicomNet.Startup()

    Using server As Server = New Server()
        Using client As Client = New Client()
            Dim storageClass As String = ""
            Dim storageInstance As String = "998.998.1.1.19950214.94000.1.102"
            Dim ds As DicomDataSet = New DicomDataSet()
            Dim element As DicomElement
            Dim transferSyntax As String = DicomUidType.JPEGLosslessNonhier14
       Dim dicomFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "IMAGE3.dic"

            '
            ' Connect to server
            '
            server.Listen("127.0.0.1", 104, 1) ' start server
            client.Connect(Nothing, 1000, "127.0.0.1", 104) ' connect to server
            If (Not client.Wait()) Then ' wait for connection to finish
                Debug.Fail("Connection timed out")
            End If
            Debug.Assert(client.LastError = DicomExceptionCode.Success, "Connection failed")
            Debug.Assert(client.IsConnected(), "Client not connected")

            ds.Load(dicomFileName, DicomDataSetLoadFlags.LoadAndClose)
            element = ds.FindFirstElement(Nothing, DicomTag.MediaStorageSOPClassUID, True)
            If Not element Is Nothing Then
                storageClass = ds.GetStringValue(element, 0)
            End If

            If storageClass.Length = 0 Then
                element = ds.FindFirstElement(Nothing, DicomTag.SOPInstanceUID, True)
                If Not element Is Nothing Then
                    storageClass = ds.GetStringValue(element, 0)
                End If
            End If

            If storageClass.Length = 0 Then
                storageClass = "1.1.1.1"
            End If

            '
            ' Get Image transfer syntax
            '
            element = ds.FindFirstElement(Nothing, DicomTag.TransferSyntaxUID, True)
            If Not element Is Nothing Then
                transferSyntax = ds.GetStringValue(element, 0)
            End If

            element = ds.FindFirstElement(Nothing, DicomTag.SOPInstanceUID, True)
            If Not element Is Nothing Then
                storageInstance = ds.GetStringValue(element, 0)
            End If

            '
            ' Send associate request
            '
            Dim associate As DicomAssociate = New DicomAssociate(True)

            associate.Called = "ServerTest"
            associate.Calling = "ClientTest"
            associate.ImplementClass = "1.2.840.114257.1"
            associate.ImplementationVersionName = "1"
            associate.MaxLength = &H100000
            associate.AddPresentationContext(1, 0, DicomUidType.VerificationClass)
            associate.AddTransfer(1, DicomUidType.ImplicitVRLittleEndian)
            associate.AddPresentationContext(3, 0, storageClass)
            associate.AddTransfer(3, transferSyntax)
            client.SendAssociateRequest(associate)
            If (Not client.Wait()) Then ' wait for connection to finish
                Debug.Fail("SendAssociateRequest timed out")
            End If

            '
            ' Send Echo Request
            '
            Dim pid As Byte = client.Association.FindAbstract(storageClass)

            client.SendCStoreRequest(pid, 2, storageClass, storageInstance, DicomCommandPriorityType.Medium, "NONE", 1, ds)
            If (Not client.Wait()) Then ' wait for connection to finish
                Debug.Fail("SendCStoreRequest timed out")
            End If

            client.CloseForced(True)
        End Using
        server.CloseForced(True)
    End Using

    DicomEngine.Shutdown()
    DicomNet.Shutdown()
End Sub
C#Copy Code
        [StructLayout(LayoutKind.Sequential)] 
public struct MSG 
{ 
    public IntPtr hwnd; 
    public uint message; 
    public IntPtr wParam; 
    public IntPtr lParam; 
    public uint time; 
    public System.Drawing.Point p; 
} 
public enum WaitReturn 
{ 
    Complete, 
    Timeout, 
} 
 
class Utils 
{ 
    [DllImport("user32.dll")] 
    [return: MarshalAs(UnmanagedType.Bool)] 
    static extern bool PeekMessage(out MSG lpMsg, IntPtr hWnd, 
                                   uint wMsgFilterMin, uint wMsgFilterMax, 
                                   uint wRemoveMsg); 
 
    [DllImport("user32.dll")] 
    static extern bool TranslateMessage([In] ref MSG lpMsg); 
    [DllImport("user32.dll")] 
    static extern IntPtr DispatchMessage([In] ref MSG lpmsg); 
 
    const uint PM_REMOVE = 1; 
 
    public static WaitReturn WaitForComplete(double mill, WaitHandle wh) 
    { 
        TimeSpan goal = new TimeSpan(DateTime.Now.AddMilliseconds(mill).Ticks); 
 
        do 
        { 
            MSG msg = new MSG(); 
 
            if (PeekMessage(out msg, IntPtr.Zero, 0, 0, PM_REMOVE)) 
            { 
                TranslateMessage(ref msg); 
                DispatchMessage(ref msg); 
            } 
 
            if (wh.WaitOne(new TimeSpan(0, 0, 0), false)) 
            { 
                return WaitReturn.Complete; 
            } 
 
            if (goal.CompareTo(new TimeSpan(DateTime.Now.Ticks)) < 0) 
            { 
                return WaitReturn.Timeout; 
            } 
 
        } while (true); 
    } 
} 
 
class Client : DicomNet 
{ 
    DicomExceptionCode _LastError = DicomExceptionCode.Success; 
    AutoResetEvent waitEvent = new AutoResetEvent(false); 
 
    public Client() 
        : base(null, DicomNetSecurityeMode.None) 
    { 
    } 
 
    public DicomExceptionCode LastError 
    { 
        get 
        { 
            return _LastError; 
        } 
    } 
 
    public bool Wait() 
    { 
        WaitReturn ret; 
 
        _LastError = DicomExceptionCode.Success; 
        ret = Utils.WaitForComplete((5 * 60) * 1000, waitEvent); 
 
        return (ret == WaitReturn.Complete); 
    } 
 
    protected override void OnConnect(DicomExceptionCode error) 
    { 
        _LastError = error; 
        waitEvent.Set(); 
    } 
 
    protected override void OnReceiveAssociateAccept(DicomAssociate association) 
    { 
        waitEvent.Set(); 
    }                     
 
    protected override void OnReceiveCStoreResponse(byte presentationID, int messageID, string affectedClass, string instance, DicomCommandStatusType status) 
    {                 
        Debug.Assert(status == DicomCommandStatusType.Success, "Status should be success"); 
        waitEvent.Set(); 
    } 
    protected override void OnReceive(DicomExceptionCode error, DicomPduType pduType, IntPtr buffer, int bytes) 
    { 
       base.OnReceive(error, pduType, buffer, bytes); 
    } 
 
   protected override void OnSend(DicomExceptionCode error, DicomPduType type, int length) 
   { 
      base.OnSend(error, type, length); 
   } 
} 
 
class ServerConnection : DicomNet 
{ 
    public ServerConnection() 
        : base(null, DicomNetSecurityeMode.None) 
    { 
    } 
 
    protected override void OnReceiveAssociateRequest(DicomAssociate association) 
    { 
        DicomAssociate retAssociation = new DicomAssociate(false); 
 
        Debug.Assert(association.Called == "ServerTest", "Called AETitle should be ServerTest"); 
        Debug.Assert(association.Calling == "ClientTest", "Calling AETitle should be ClientTest"); 
        Debug.Assert(association.ImplementClass == "1.2.840.114257.1", "Implementation class should be 1.2.840.114257.1"); 
        Debug.Assert(association.ImplementationVersionName == "1", "Implementation version should be 1"); 
        Debug.Assert(association.MaxLength == 0x100000, "Max length should be 0x100000"); 
        Debug.Assert(association.GetAbstract(1) == DicomUidType.VerificationClass, "Presentation index 1 should be " + DicomUidType.VerificationClass); 
        Debug.Assert(association.GetTransfer(1, 0) == DicomUidType.ImplicitVRLittleEndian, "Abstract Syntax (1,0) should be " + DicomUidType.ImplicitVRLittleEndian); 
 
        // 
        // Build our Association Accept 
        // 
        retAssociation.Called = association.Called; 
        retAssociation.Calling = association.Calling; 
        retAssociation.ImplementClass = association.ImplementClass; 
        retAssociation.ImplementationVersionName = association.ImplementationVersionName; 
        for (int x = 0; x < association.PresentationContextCount; x++) 
        { 
            byte id = association.GetPresentationContextID(x); 
            string abSyntax = association.GetAbstract(id); 
            string trSyntax = DicomUidType.ImplicitVRLittleEndian; 
 
            retAssociation.AddPresentationContext(id, 0, abSyntax); 
            if (association.GetTransferCount(id) > 0) 
            { 
                trSyntax = association.GetTransfer(id, 0); 
            } 
 
            retAssociation.AddTransfer(id, trSyntax); 
        } 
        SendAssociateAccept(retAssociation); 
    }             
 
    protected override void OnReceiveCStoreRequest(byte presentationID, int messageID, string affectedClass, string instance, DicomCommandPriorityType priority, string moveAE, int moveMessageID, DicomDataSet dataSet) 
    { 
        byte id = Association.FindAbstract(affectedClass);                 
 
        Debug.Assert(id == presentationID, "PresentationID is invalid"); 
        Debug.Assert(messageID == 2, "Invalid message id.  Should be 2"); 
        Debug.Assert(dataSet != null, "Dataset should not be null"); 
        Debug.Assert(moveAE == "NONE", "Move AE should be NONE");                
        Debug.Assert(moveMessageID == 1, "Move message id should be 1"); 
        Debug.Assert(priority == DicomCommandPriorityType.Medium, "Priority should be medium"); 
 
        SendCStoreResponse(presentationID, messageID, affectedClass, instance, DicomCommandStatusType.Success); 
    } 
} 
 
class Server : DicomNet 
{ 
    ServerConnection client; 
 
    public Server() 
        : base(null, DicomNetSecurityeMode.None) 
    { 
    } 
 
    protected override void OnAccept(DicomExceptionCode error) 
    { 
        client = new ServerConnection(); 
 
        Accept(client); 
    } 
} 
 
 
public void SendCStoreRequestSample() 
{ 
    DicomEngine.Startup(); 
    DicomNet.Startup(); 
 
    using (Server server = new Server()) 
    { 
        using (Client client = new Client()) 
        { 
            string storageClass = ""; 
            string storageInstance = "998.998.1.1.19950214.94000.1.102"; 
            DicomDataSet ds = new DicomDataSet(); 
            DicomElement element; 
            string transferSyntax = DicomUidType.JPEGLosslessNonhier14; 
            string dicomFileName = LeadtoolsExamples.Common.ImagesPath.Path + "IMAGE3.dic"; 
 
            // 
            // Connect to server 
            // 
            server.Listen("127.0.0.1", 104, 1); // start server 
            client.Connect(null, 1000, "127.0.0.1", 104); // connect to server 
            if (!client.Wait()) // wait for connection to finish 
            { 
                Debug.Fail("Connection timed out"); 
            } 
            Debug.Assert(client.LastError == DicomExceptionCode.Success, "Connection failed"); 
            Debug.Assert(client.IsConnected(), "Client not connected"); 
 
            ds.Load(dicomFileName, DicomDataSetLoadFlags.LoadAndClose); 
            element = ds.FindFirstElement(null, DicomTag.MediaStorageSOPClassUID, true); 
            if (element != null) 
            { 
                storageClass = ds.GetStringValue(element, 0); 
            } 
 
            if (storageClass.Length == 0) 
            { 
               element = ds.FindFirstElement(null, DicomTag.SOPInstanceUID, true); 
                if (element != null) 
                { 
                    storageClass = ds.GetStringValue(element, 0); 
                } 
            } 
 
            if (storageClass.Length == 0) 
                storageClass = "1.1.1.1"; 
 
            // 
            // Get Image transfer syntax 
            // 
             element = ds.FindFirstElement(null, DicomTag.TransferSyntaxUID, true); 
            if (element != null) 
            { 
                transferSyntax = ds.GetStringValue(element, 0); 
            } 
 
            element = ds.FindFirstElement(null, DicomTag.SOPInstanceUID, true); 
            if (element != null) 
            { 
                storageInstance = ds.GetStringValue(element, 0); 
            } 
 
            // 
            // Send associate request 
            // 
            DicomAssociate associate = new DicomAssociate(true); 
 
            associate.Called = "ServerTest"; 
            associate.Calling = "ClientTest"; 
            associate.ImplementClass = "1.2.840.114257.1"; 
            associate.ImplementationVersionName = "1"; 
            associate.MaxLength = 0x100000; 
            associate.AddPresentationContext(1, 0, DicomUidType.VerificationClass); 
            associate.AddTransfer(1, DicomUidType.ImplicitVRLittleEndian); 
            associate.AddPresentationContext(3, 0, storageClass); 
            associate.AddTransfer(3, transferSyntax); 
            client.SendAssociateRequest(associate); 
            if (!client.Wait()) // wait for connection to finish 
            { 
                Debug.Fail("SendAssociateRequest timed out"); 
            } 
 
            // 
            // Send Echo Request 
            // 
            byte pid = client.Association.FindAbstract(storageClass); 
 
            client.SendCStoreRequest(pid, 2, storageClass, storageInstance,  
                                     DicomCommandPriorityType.Medium, "NONE", 1, ds); 
            if (!client.Wait()) // wait for connection to finish 
            { 
                Debug.Fail("SendCStoreRequest timed out"); 
            } 
 
            client.CloseForced(true); 
        } 
        server.CloseForced(true); 
    } 
 
    DicomEngine.Shutdown(); 
    DicomNet.Shutdown(); 
}

Remarks

This is a low level means of receiving DICOM messages and data. It allows you to process messages yourself, instead of using the high level message processing methods provided.

This method is generated for each DicomNet.SendXXX method provided by LEADTOOLS.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features