Struct ClientAssociation 

pub struct ClientAssociation<S> { /* 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).

Call release at the end to perform a standard C-RELEASE message exchange and shut down the underlying TCP connection. Not calling this method will only close the socket without gracefully releasing the association.

Implementations

impl<S> ClientAssociation<S>

where S: CloseSocket + Read + Write,

pub fn read_timeout(&self) -> Option<Duration>

Retrieve read timeout for the association

pub fn write_timeout(&self) -> Option<Duration>

Retrieve write timeout for the association

pub fn acceptor_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length that the association acceptor is expecting to receive.

pub fn requestor_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length that the association requestor is expecting to receive.

pub fn user_variables(&self) -> &[UserVariableItem]

Retrieve the user variables that were taken from the server.

It usually contains the maximum PDU length, the implementation class UID, and the implementation version name.

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

Retrieve the list of negotiated presentation contexts.

impl<S> ClientAssociation<S>

where S: CloseSocket + Read + Write,

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

Send a PDU message to the other intervenient.

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

Read a PDU message from the other intervenient.

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

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

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

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

Iniate a graceful release of the association.

A DIMSE A-RELEASE transaction is initiated by this application entity, and the underlying socket is closed once settled.

Note that as of version 0.9.1, ClientAssociation no longer calls this method on Drop, so remember to call release explicitly at the end of all DIMSE transactions.

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

Send a provider initiated abort message and shut down the TCP connection, terminating the association.

pub fn receive_pdata(&mut self) -> PDataReader<'_, &mut S>

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.

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

Obtain access to the inner 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.

Trait Implementations

impl Release for ClientAssociation<TcpStream>

fn release(&mut self) -> Result<(), Error>

👎Deprecated since 0.9.1: Call SyncAssociation::release instead

impl<S> Association for ClientAssociation<S>

where S: CloseSocket + Read + Write,

fn acceptor_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length that the association acceptor is expecting to receive.

fn requestor_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length that the association requestor is expecting to receive.

fn local_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length that this application entity (the association requestor) is expecting to receive.

fn peer_max_pdu_length(&self) -> u32

Retrieve the maximum PDU length that the peer application entity (the association acceptor) is expecting to receive.

fn peer_ae_title(&self) -> &str

Obtain the remote DICOM node’s application entity title.

fn presentation_contexts(&self) -> &[PresentationContextNegotiated]

Obtain a view of the negotiated presentation contexts.

fn user_variables(&self) -> &[UserVariableItem]

Retrieve the user variables that were taken from the server.

impl<S: Debug> Debug for ClientAssociation<S>

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

Formats the value using the given formatter.

impl<S> SyncAssociation<S> for ClientAssociation<S>

where S: CloseSocket + Read + Write,

fn inner_stream(&mut self) -> &mut S

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

fn get_mut(&mut self) -> (&mut S, &mut BytesMut)

Obtain mutable access to the inner stream and read buffer

fn send(&mut self, pdu: &Pdu) -> Result<(), Error>

Send a PDU message to the other intervenient.

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

Read a PDU message from the other intervenient.

fn abort(self) -> Result<(), Error>

where Self: Sized,

Send a provider initiated abort message and shut down the TCP connection, terminating the association.

fn release(self) -> Result<(), Error>

where Self: Sized,

Iniate a graceful release of the association.

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

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

fn receive_pdata(&mut self) -> PDataReader<'_, &mut S>

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