pynetdicom.ae.ApplicationEntity

class pynetdicom.ae.ApplicationEntity(ae_title=b'PYNETDICOM')

Represents a DICOM Application Entity (AE).

An AE may be a Service Class Provider (SCP), a Service Class User (SCU) or both.

acse_timeout

The maximum amount of time (in seconds) to wait for association related messages. A value of None means no timeout. (default: 30)

Type

int or float or None

ae_title

The local AE’s AE title.

Type

bytes

dimse_timeout

The maximum amount of time (in seconds) to wait for DIMSE related messages. A value of None means no timeout. (default: 30)

Type

int or float or None

network_timeout

The maximum amount of time (in seconds) to wait for network messages. A value of None means no timeout. (default: 60)

Type

int or float or None

maximum_associations

The maximum number of simultaneous associations requested by remote AEs. Note that this does not include the number of associations requested by the local AE (default 10).

Type

int

maximum_pdu_size

The maximum PDU receive size in bytes. A value of 0 means there is no maximum size (default: 16382)

Type

int

require_calling_aet

If not an empty list, the association request’s Calling AE Title value must match one of the values in require_calling_aet. If an empty list then no matching will be performed (default). (Association acceptor only).

Type

list of bytes

require_called_aet

If True, the association request’s Called AE Title value must match AE.ae_title (default False). (Association acceptor only).

Type

bool

__init__(ae_title=b'PYNETDICOM')

Create a new Application Entity.

Parameters

ae_title (bytes, optional) – The AE title of the Application Entity (default: b'PYNETDICOM')

Methods

__init__([ae_title])	Create a new Application Entity.
add_requested_context(abstract_syntax[, ...])	Add a presentation context to be proposed when requesting an association.
add_supported_context(abstract_syntax[, ...])	Add a presentation context to be supported when accepting association requests.
associate(addr, port[, contexts, ae_title, ...])	Request an association with a remote AE.
on_association_aborted([primitive])	Callback for when an association is aborted.
on_association_accepted(primitive)	Callback for when an association is accepted.
on_association_rejected(primitive)	Callback for when an association is rejected.
on_association_released([primitive])	Callback for when an association is released.
on_async_ops_window(nr_invoked, nr_performed)	Callback for when an Asynchronous Operations Window Negotiation item is include in the association request.
on_c_echo(context, info)	Callback for when a C-ECHO request is received.
on_c_find(dataset, context, info)	Callback for when a C-FIND request is received.
on_c_get(dataset, context, info)	Callback for when a C-GET request is received.
on_c_move(dataset, move_aet, context, info)	Callback for when a C-MOVE request is received.
on_c_store(dataset, context, info)	Callback for when a C-STORE request is received.
on_n_get(attr, context, info)	Callback for when an N-GET request is received.
on_sop_class_common_extended(items)	Callback for when one or more SOP Class Common Extended Negotiation items are included in the association request.
on_sop_class_extended(app_info)	Callback for when one or more SOP Class Extended Negotiation items are included in the association request.
on_user_identity(user_id_type, ...)	Callback for when a user identity negotiation item is included with the association request.
remove_requested_context(abstract_syntax[, ...])	Remove a requested presentation context.
remove_supported_context(abstract_syntax[, ...])	Remove a supported presentation context.
shutdown()	Stop any active association servers and threads.
start_server(address[, block, ssl_context, ...])	Start the AE as an association acceptor.

Attributes

acse_timeout	Return the ACSE timeout value.
active_associations	Return a list of the AE's active Association threads.
ae_title	Return the AE title as length 16 bytes.
dimse_timeout	Return the DIMSE timeout.
implementation_class_uid	Return the current Implementation Class UID.
implementation_version_name	Return the current Implementation Version Name.
maximum_associations	Return the number of maximum associations as int.
maximum_pdu_size	Return the maximum PDU size accepted by the AE as int.
network_timeout	Return the network timeout.
requested_contexts	Return a list of the requested PresentationContext items.
require_called_aet	Return whether the Called AE Title must match the AE title.
require_calling_aet	Return the required calling AE title as a list of bytes.
supported_contexts	Return a list of the supported PresentationContexts items.