pynetdicom.transport.AssociationServer

class pynetdicom.transport.AssociationServer(ae, address, ssl_context=None)

An Association server implementation.

Any attempts to connect will be assumed to be from association requestors.

The server should be started with serve_forever(poll_interval), where poll_interval is the timeout (in seconds) that the select.select() call will block for (default 0.5). A value of 0 specifies a poll and never blocks. A value of None blocks until a connection is ready.

ae

The parent AE that is running the server.

Type:ae.ApplicationEntity

server_address

The (host, port) that the server is running on.

Type:2-tuple

ssl_context

The SSLContext used to wrap client sockets, or None if no TLS is required.

Type:ssl.SSLContext or None

request_queue_size

Default 5.

Type:int

__init__(ae, address, ssl_context=None)

Create a new AssociationServer, bind a socket and start listening.

Parameters:

• ae (ae.ApplicationEntity) – The parent AE that’s running the server.
• address (2-tuple) – The (host, port) that the server should run on.
• ssl_context (ssl.SSLContext, optional) – If TLS is to be used then this should be the ssl.SSLContext used to wrap the client sockets, otherwise if None then no TLS will be used (default).

Methods

__init__(ae, address[, ssl_context])	Create a new AssociationServer, bind a socket and start listening.
close_request(request)	Called to clean up an individual request.
fileno()	Return socket file number.
finish_request(request, client_address)	Finish one request by instantiating RequestHandlerClass.
get_request()	Handle a connection request.
handle_error(request, client_address)	Handle an error gracefully.
handle_request()	Handle one request, possibly blocking.
handle_timeout()	Called if no new request arrives within self.timeout.
process_request(request, client_address)	Process a connection request.
serve_forever([poll_interval])	Handle one request at a time until shutdown.
server_activate()	Called by constructor to activate the server.
server_bind()	Bind the socket and set the socket options.
server_close()	Close the server.
service_actions()	Called by the serve_forever() loop.
shutdown()	Completely shutdown the server and close it’s socket.
shutdown_request(request)	Called to shutdown and close an individual request.
verify_request(request, client_address)	Verify the request.

Attributes

address_family
allow_reuse_address
request_queue_size
socket_type
timeout

close_request(request)

Called to clean up an individual request.

fileno()

Return socket file number.

Interface required by selector.

finish_request(request, client_address)

Finish one request by instantiating RequestHandlerClass.

get_request()

Handle a connection request.

If ssl_context is set then the client socket will be wrapped using ssl_context.wrap_socket().

Returns:

• client_socket (socket._socket) – The connection request.
• address (2-tuple) – The client’s address as (host, port).

handle_error(request, client_address)

Handle an error gracefully. May be overridden.

The default is to print a traceback and continue.

handle_request()

Handle one request, possibly blocking.

Respects self.timeout.

handle_timeout()

Called if no new request arrives within self.timeout.

Overridden by ForkingMixIn.

process_request(request, client_address)

Process a connection request.

serve_forever(poll_interval=0.5)

Handle one request at a time until shutdown.

Polls for shutdown every poll_interval seconds. Ignores self.timeout. If you need to do periodic tasks, do them in another thread.

server_activate()

Called by constructor to activate the server.

May be overridden.

server_bind()

Bind the socket and set the socket options.

• socket.SO_REUSEADDR is set to 1
• socket.SO_RCVTIMEO is set to AE.network_timeout unless the value is None in which case it will be left unset.

server_close()

Close the server.

service_actions()

Called by the serve_forever() loop.

May be overridden by a subclass / Mixin to implement any code that needs to be run during the loop.

shutdown()

Completely shutdown the server and close it’s socket.

shutdown_request(request)

Called to shutdown and close an individual request.

verify_request(request, client_address)

Verify the request. May be overridden.

Return True if we should proceed with this request.