AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Messaging.MessagingAddress Class Reference

A protocol-agnostic address used to present senders and recipients to message handling parts of the system. More...

Public Member Functions

 MessagingAddress (Configuration.MessagingAddressElement config)
 Creates a MessagingAddress from configuration. More...
 
 MessagingAddress (string name, string address)
 Creates a MessagingAddress from its component parts. More...
 
 MessagingAddress (string refName, string name, string address)
 Initializes a new instance of the MessagingAddress class from configuration. This constructor creates an address including it's referenced name. More...
 

Properties

string Name [get]
 The name of the addressee to which the message is to be delivered. More...
 
string Address [get]
 The protocol-specific address to be used by the message handler. More...
 
string RefName [get]
 Gets the name of the reference that was used to specify the address. More...
 

Detailed Description

A protocol-agnostic address used to present senders and recipients to message handling parts of the system.

Constructor & Destructor Documentation

◆ MessagingAddress() [1/3]

Apac.Messaging.MessagingAddress.MessagingAddress ( Configuration.MessagingAddressElement  config)
inline

Creates a MessagingAddress from configuration.

Parameters
configThe configuration element to be used as the source for data.

This class was created, rather than passing around the configuration elements themselves because those objects can be volatile and if they should be changed while the message handler is in mid-call, it might cause problems with addressing.

◆ MessagingAddress() [2/3]

Apac.Messaging.MessagingAddress.MessagingAddress ( string  name,
string  address 
)
inline

Creates a MessagingAddress from its component parts.

Parameters
nameSee Name.
addressSee Address.

◆ MessagingAddress() [3/3]

Apac.Messaging.MessagingAddress.MessagingAddress ( string  refName,
string  name,
string  address 
)
inline

Initializes a new instance of the MessagingAddress class from configuration. This constructor creates an address including it's referenced name.

Parameters
refNameThe name used to reference the address.
nameThe name of the address.
addressThe address.

Property Documentation

◆ Address

string Apac.Messaging.MessagingAddress.Address
get

The protocol-specific address to be used by the message handler.

◆ Name

string Apac.Messaging.MessagingAddress.Name
get

The name of the addressee to which the message is to be delivered.

◆ RefName

string Apac.Messaging.MessagingAddress.RefName
get

Gets the name of the reference that was used to specify the address.

The name of the reference.


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