This class represents the status from one attempt to deliver a Message over a single protocol. A Message may have several of these More...

Inheritance diagram for Apac.Messaging.DeliveryStatus:

Public Member Functions
	DeliveryStatus (MessagingProtocols protocol)
	Creates a new DeliveryStatus instance that defaults to not delivered. More...

	DeliveryStatus (MessagingProtocols protocol, WhyBool delivered)
	Creats a new DeliveryStatus instance and sets the delivered property as specified by delivered . More...

	DeliveryStatus ()
	Parameterless constructor to support XML serialization. More...

	DeliveryStatus (SerializationInfo info, StreamingContext context)
	Constructor used in binary deserialization. More...

void	GetObjectData (SerializationInfo info, StreamingContext context)
	The serializing method for binary data. More...

System.Xml.Schema.XmlSchema	GetSchema ()
	This method is a no-op. We have opted to use the System.Xml.Serialization.XmlSchemaProviderAttribute instead. More...

void	ReadXml (System.Xml.XmlReader reader)
	Deserializes object data from XML format. More...

void	WriteXml (System.Xml.XmlWriter writer)
	Serializes object data to XML format. More...

Protected Member Functions
virtual void	OnReadXml (System.Xml.XmlReader reader)
	The virtual plug-in point for XML deserialization, for subclasses to participate. More...

virtual void	OnWriteXml (System.Xml.XmlWriter writer)
	The virtual plug-in point for XML serialization, for subclasses to participate. More...

Properties
MessagingProtocols	Protocol `[get]`
	Gets the protocol used for the delivery. More...

WhyBool	Delivered `[get]`
	Gets the WhyBool reference containing the delivery status and the reason for failure, if any. More...

DateTime	Timestamp `[get]`
	Gets the time stamp for when the message entered the message control system. More...

string	Hostname `[get]`
	Gets the host name of the server where the message was delivered from. More...

Detailed Description

This class represents the status from one attempt to deliver a Message over a single protocol. A Message may have several of these

Constructor & Destructor Documentation

◆ DeliveryStatus() [1/4]

Apac.Messaging.DeliveryStatus.DeliveryStatus ( MessagingProtocols protocol )

inline

Creates a new DeliveryStatus instance that defaults to not delivered.

Parameters

protocol The protocol used for the delivery.

◆ DeliveryStatus() [2/4]

Apac.Messaging.DeliveryStatus.DeliveryStatus	(	MessagingProtocols	protocol,
		WhyBool	delivered
	)

inline

Creats a new DeliveryStatus instance and sets the delivered property as specified by delivered .

Parameters

protocol	The protocol used for the delivery.
delivered	The WhyBool instance that indicates delivery status and the reason for failure, if any.

◆ DeliveryStatus() [3/4]

Apac.Messaging.DeliveryStatus.DeliveryStatus ( )

inline

Parameterless constructor to support XML serialization.

◆ DeliveryStatus() [4/4]

Apac.Messaging.DeliveryStatus.DeliveryStatus	(	SerializationInfo	info,
		StreamingContext	context
	)

inline

Constructor used in binary deserialization.

Parameters

info	See SerializationInfo.
context	See StreamingContext.

Member Function Documentation

◆ GetObjectData()

void Apac.Messaging.DeliveryStatus.GetObjectData	(	SerializationInfo	info,
		StreamingContext	context
	)

inline

The serializing method for binary data.

Parameters

info	See SerializationInfo.
context	See StreamingContext.

◆ GetSchema()

System.Xml.Schema.XmlSchema Apac.Messaging.DeliveryStatus.GetSchema ( )

inline

This method is a no-op. We have opted to use the System.Xml.Serialization.XmlSchemaProviderAttribute instead.

Returns: Returns null.

◆ OnReadXml()

virtual void Apac.Messaging.DeliveryStatus.OnReadXml ( System.Xml.XmlReader reader )

inlineprotectedvirtual

The virtual plug-in point for XML deserialization, for subclasses to participate.

Parameters

reader The System.Xml.XmlReader containing the serialized data.

◆ OnWriteXml()

virtual void Apac.Messaging.DeliveryStatus.OnWriteXml ( System.Xml.XmlWriter writer )

inlineprotectedvirtual

The virtual plug-in point for XML serialization, for subclasses to participate.

Parameters

writer The System.Xml.XmlWriter receiving the serialized data.

◆ ReadXml()

void Apac.Messaging.DeliveryStatus.ReadXml ( System.Xml.XmlReader reader )

inline

Deserializes object data from XML format.

Parameters

reader The System.Xml.XmlReader containing the serialized data.

◆ WriteXml()

void Apac.Messaging.DeliveryStatus.WriteXml ( System.Xml.XmlWriter writer )

inline

Serializes object data to XML format.

Parameters

writer The System.Xml.XmlWriter receiving the serialized data.

Property Documentation

◆ Delivered

WhyBool Apac.Messaging.DeliveryStatus.Delivered

get

Gets the WhyBool reference containing the delivery status and the reason for failure, if any.

◆ Hostname

string Apac.Messaging.DeliveryStatus.Hostname

get

Gets the host name of the server where the message was delivered from.

◆ Protocol

MessagingProtocols Apac.Messaging.DeliveryStatus.Protocol

get

Gets the protocol used for the delivery.

◆ Timestamp

DateTime Apac.Messaging.DeliveryStatus.Timestamp

get

Gets the time stamp for when the message entered the message control system.

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

/var/lib/jenkins/workspace/apac/APAC/APACCore/Messaging/DeliveryStatus.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DeliveryStatus() [1/4]

◆ DeliveryStatus() [2/4]

◆ DeliveryStatus() [3/4]

◆ DeliveryStatus() [4/4]

Member Function Documentation

◆ GetObjectData()

◆ GetSchema()

◆ OnReadXml()

◆ OnWriteXml()

◆ ReadXml()

◆ WriteXml()

Property Documentation

◆ Delivered

◆ Hostname

◆ Protocol

◆ Timestamp