pynetdicom._handlers.doc_handle_echo

pynetdicom._handlers.doc_handle_echo(event)[source][source]

Documentation for handlers bound to evt.EVT_C_ECHO.

User implementation of this event handler is optional. If a handler is not implemented and bound to evt.EVT_C_ECHO then the C-ECHO request will be responded to using a Status value of 0x0000 - Success.

Event

evt.EVT_C_ECHO

Supported Service Classes

  • Verification Service Class

Status

Success
0x0000 Success
Failure
0x0122 Refused: SOP Class Not Supported
0x0210 Refused: Duplicate Invocation
0x0211 Refused: Unrecognised Operation
0x0212 Refused: Mistyped Argument
Parameters

event (events.Event) –

The event representing a service class receiving a C-ECHO request message. Event attributes are:

  • assoc : the association that is running the DICOM service that received the C-ECHO request.

  • context : the presentation context the request was sent under as a presentation.PresentationContextTuple.

  • description : a description of the event that occurred as str.

  • name : the name of the event that occurred as str.

  • request : the received C-ECHO request

  • timestamp : the date and time that the C-ECHO request was processed by the service.

Returns

status – The status returned to the peer AE in the C-ECHO response. Must be a valid C-ECHO status value for the applicable Service Class as either an int or a Dataset object containing (at a minimum) a (0000,0900) Status element. If returning a Dataset object then it may also contain optional elements related to the Status (as in the DICOM Standard Part 7, Annex C).

Return type

pydicom.dataset.Dataset or int

See also

send_c_echo() C_ECHO VerificationServiceClass

References