dcmtkpp
Classes | Public Member Functions | List of all members
dcmtkpp::Association Class Reference

Wrapper around the T_ASC_Association class. More...

#include <Association.h>

Public Member Functions

 Association ()
 Create a default, un-associated, association.
 
 Association (Association const &other)
 Create an un-associated association.
 
 ~Association ()
 Destroy the association, release it if necessary.
 
Associationoperator= (Association const &other)
 Assing an un-associated association; it remains un-associated.
 
std::string const & get_own_ae_title () const
 Return the AE title of the caller. Defaults to "".
 
void set_own_ae_title (std::string const &ae_title)
 Set the AE title of the caller.
 
Peer
std::string const & get_peer_host_name () const
 Return the host name of the peer. Defaults to "".
 
void set_peer_host_name (std::string const &host_name)
 Set the host name of the peer.
 
uint16_t get_peer_port () const
 Return the port of the peer. Defaults to 104.
 
void set_peer_port (uint16_t port)
 Set the port of the peer.
 
std::string const & get_peer_ae_title () const
 Return the AE title of the peer. Defaults to "".
 
void set_peer_ae_title (std::string const &ae_title)
 Set the AE title of the peer.
 
Presentation contexts
void add_presentation_context (std::string const &abstract_syntax, std::vector< std::string > const &transfer_syntaxes, T_ASC_SC_ROLE role=ASC_SC_ROLE_DEFAULT)
 
User identity
UserIdentityType get_user_identity_type () const
 Return the user identity type. Defaults to None.
 
void set_user_identity_type (UserIdentityType type)
 Set the user identity type.
 
std::string const & get_user_identity_primary_field () const
 Return the user identity primary field. Defaults to "".
 
void set_user_identity_primary_field (std::string const &value)
 Set the user identity primary field.
 
std::string const & get_user_identity_secondary_field () const
 Return the user identity secondary field. Defaults to "".
 
void set_user_identity_secondary_field (std::string const &value)
 Set the user identity secondary field.
 
void set_user_identity_to_none ()
 Do no authenticate user.
 
void set_user_identity_to_username (std::string const &username)
 Authenticate user using only a username.
 
void set_user_identity_to_username_and_password (std::string const &username, std::string const &password)
 Authenticate user using a username and a password.
 
void set_user_identity_to_kerberos (std::string const &ticket)
 Authenticate user using a Kerberos ticket.
 
void set_user_identity_to_saml (std::string const &assertion)
 Authenticate user using a SAML assertion.
 
Association
bool is_associated () const
 Test whether the object is currently associated to its peer.
 
void associate (Network &network)
 Request an association with the peer. More...
 
void receive (Network &network, bool accept_all=false)
 Receive an association for a peer. More...
 
T_ASC_Association * get_association ()
 Return the association object.
 
void release ()
 Gracefully release the association. Throws an exception if not associated.
 
void abort ()
 Forcefully release the association. Throws an exception if not associated.
 
void drop ()
 Drop an association that has been released by the peer.
 

Detailed Description

Wrapper around the T_ASC_Association class.

No member can be set while the object is associated.

Member Function Documentation

void dcmtkpp::Association::associate ( Network network)

Request an association with the peer.

Parameters
networknetwork to use for the data transmission.

Throws an exception if already associated.

void dcmtkpp::Association::receive ( Network network,
bool  accept_all = false 
)

Receive an association for a peer.

Parameters
networknetwork to use for the data transmission.
accept_allif true, accept all presentations contexts proposed by peer.

The documentation for this class was generated from the following files: