Struct ClientAssociation

pub struct ClientAssociation { /* private fields */ }

A DICOM upper level association from the perspective of a requesting application entity.

The most common operations of an established association are send and receive. Sending large P-Data fragments may be easier through the P-Data sender abstraction (see send_pdata).

When the value falls out of scope, the program will automatically try to gracefully release the association through a standard C-RELEASE message exchange, then shut down the underlying TCP connection.

Implementations

impl ClientAssociation

pub fn presentation_contexts(&self) -> &[PresentationContextResult]

Retrieve the list of negotiated presentation contexts.

pub fn acceptor_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length admitted by the association acceptor.

pub fn requestor_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length that this application entity is expecting to receive.

The current implementation is not required to fail and/or abort the association if a larger PDU is received.

pub fn send(&mut self, msg: &Pdu) -> Result<()>

Send a PDU message to the other intervenient.

pub fn receive(&mut self) -> Result<Pdu>

Read a PDU message from the other intervenient.

pub fn release(self) -> Result<()>

Gracefully terminate the association by exchanging release messages and then shutting down the TCP connection.

pub fn abort(self) -> Result<()>

Send an abort message and shut down the TCP connection, terminating the association.

pub fn inner_stream(&mut self) -> &mut TcpStream

Obtain access to the inner TCP stream connected to the association acceptor.

This can be used to send the PDU in semantic fragments of the message, thus using less memory.

Note: reading and writing should be done with care to avoid inconsistencies in the association state. Do not call send and receive while not in a PDU boundary.

pub fn send_pdata( &mut self, presentation_context_id: u8, ) -> PDataWriter<&mut TcpStream>

Prepare a P-Data writer for sending one or more data items.

Returns a writer which automatically splits the inner data into separate PDUs if necessary.

pub fn receive_pdata(&mut self) -> PDataReader<&mut TcpStream>

Prepare a P-Data reader for receiving one or more data item PDUs.

Returns a reader which automatically receives more data PDUs once the bytes collected are consumed.

Trait Implementations

impl Debug for ClientAssociation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for ClientAssociation

Automatically release the association and shut down the connection.

fn drop(&mut self)

Executes the destructor for this type.