pynetdicom._handlers.doc_handle_echo¶

pynetdicom._handlers.doc_handle_echo(event: Event, *args: Sequence[Any]) → Union[int, Dataset][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 - SOP Class Not Supported

0x0210 - Duplicate Invocation

0x0211 - Unrecognised Operation

0x0212 - 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 PresentationContextTuple.
- event: the event that occurred as an InterventionEvent.
- request: the received C-ECHO request
- timestamp: the date and time that the C-ECHO request was processed by the service as datetime.datetime.
Event properties are:
- message_id: the C-ECHO request’s Message ID as int.
args – If the handler was bound to the event using bind(event, handler, args) or by passing evt_handlers=[(event, handler, args), ...], where args is a list then there will be one or more optional extra parameters matching the contents of args.

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