Amqp |
Primary class used by endpoint implementers to facility bi-directional, AMQP 1.0 based communications. Using this class, endpoints
may publish messages to one or more destinations, subscribe to receive messages from one or more sources, and process incoming
CFX requests from other CFX endpoints. This class also supports security features, including secure AMQP 1.0 protocol (AMQPS or AMQP over TLS),
as well as SASL based authentication (Simple Authentication and Security Layer). At the time of this writing, the endpoint has been tested
and verified for use with the RabbitMQ broker (with AMQP 1.0 plug-in enabled), as well as the Apache Qpid broker.
Inheritance HierarchyNamespace: CFX.Transport
Assembly: CFX (in CFX.dll) Version: 2.0.0+5bb1f71a933ed371a0f5f2d5e7db34c89b75f3ea
SyntaxThe AmqpCFXEndpoint type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AmqpCFXEndpoint | Default Constructor |
Properties| Name | Description | |
|---|---|---|
 | CFXHandle | Returns the CFXHandle of the endpoint currently associated with this AMQP endpoint. |
 | Codec | Sets the codec used to transmit messages across the wire, including the newly introduced GZIP Compressed Codec, which is now the default. |
| DurableMessages | The AMQP 1.0 message framing header includes a "Durable" property that notifies recipients that this message should be maintained in durable storage on the message broker until delivered to all recipients, surviving broker system restarts. When this property is set to true, all messages published by the endpoint will be tagged with the Durable framing header. The default value is true. |
| DurableReceiverSetting | Establishes the value of the Durable framing header flag for subscription channels. Different brokers will interprety this value differently. Refer to your broker documentation to determine how to set this flag. The default setting is 1 (which signals to RabbitMQ that durable messages should be removed from their queue once successfully delivered to this endpoint). |
| HeartbeatFrequency | The AmqpCFXEndpoint class automatically publishies CFX Heartbeat messages on 1 minute intervals by default. You can adjust this frequency using this property. If set to zero (0), automatic publication of Heartbeat messages will be disabled. The minimum frequency is 1 second and the maximum frequency is 5 minutes. |
| IsOpen | Read-only property indicating whether or not the endpoint is in an open state. |
| KeepAliveEnabled | When enabled, the endpoint will automatically refresh (disconnect/reconnect) all of its subscription channels. This is to prevent brokers from timing out the connection when the channel has been dormant for a period of time. The default setting is 60 seconds. |
| KeepAliveInterval | If keep alive is enabled, this property specifies the time period between keep alive reconnects. |
| MaxFrameSize | Used by the AMQP protocol to establish the maximum number of bytes to transmit per "frame" (aka "chunk"). Larger messages may be broken down into multiple frames if their size exceeds the max frame size. The default size is 500,000 bytes. |
| MaxMessagesPerTransmit | When applicable, the endpoint will attempt to publish multiple messages in one AMQP transaction. This is done to maximize effeciency. This property sets the maximum number of messages that may be grouped together in a single AMQP message. The default value is 30 messages. |
| ReconnectInterval | The time interval between attempts to reconnect publish or subscriber channels after a network interruption. The default setting is false. |
| RequestTimeout | When executing a point to point request/response call to another CFX endpoint, this time span specifies the maximum amount of time that this endpoint will wait for the other endpoint to respond before timing out. The default is 30 seconds. |
| RequestUri | Returns the Uri currently being used to accept incoming CFX requests for this endpoint |
| SubjectFormat |
Establishes the format for the subject property of the AMQP message envelope on all messages published
by this endpoint. The following tags may be used in the format string:
|
| ValidateCertificates | If set to false, certificate validation will be disabled. This should only be used for testing purposes when a valid, commercial SSL certificate is not available for testing. |
Methods| Name | Description | |
|---|---|---|
| AddListener | Allows this endpoint to listen for and receive unsolicited (published) messages directly from multiple CFX endpoints that have been configured to publish messages to this endpoint, just like a message broker. Your endpoint must be configured to receive requests (via the Open method requestUri parameter) before adding a listener. |
| AddMessageSource | Set up a message source on this endpoint that other endpoints may subscribe to. Messages published to a message source are placed in a queue, and remain there until a subscriber connects and removes them. The queue is volatile, and will be deleted when the hosting process is restarted. |
| AddPublishChannel(AmqpChannelAddress, String, X509Certificate) | Adds a new publish channel for this endpoint. All messages published by the endpoint will be transmitted to one or more publish channels that are established using this method. Only call this methoud after this endpoint has been opened by the Open method. |
| AddPublishChannel(Uri, String, String, X509Certificate) | Adds a new publish channel for this endpoint. All messages published by the endpoint will be transmitted to one or more publish channels that are established using this method. Only call this methoud after this endpoint has been opened by the Open method. |
| AddSubscribeChannel(AmqpChannelAddress, String, X509Certificate) | Adds a new subscription channel for this endpoint. |
| AddSubscribeChannel(Uri, String, String, X509Certificate) | Adds a new subscription channel for this endpoint. |
| Close | Closes the endpoint, including all inbound and outbound channels. |
| CloseListener | Closes a previously added listener (added with AddListener method). |
| CloseMessageSource | Closes a previously added message source. All messages in the source's queue will be purged upon closing. |
| ClosePublishChannel(AmqpChannelAddress) | Closes the specified publish channel (that was opened previously via a call to AddPublishChannel. |
| ClosePublishChannel(Uri, String) | Closes the specified publish channel (that was opened previously via a call to AddPublishChannel. |
| CloseSubscribeChannel(AmqpChannelAddress) | Closes the specified subscription channel (that was opened previously via a call to AddSubscribeChannel. |
| CloseSubscribeChannel(Uri, String) | Closes the specified subscription channel (that was opened previously via a call to AddSubscribeChannel. |
| Dispose | Disposes the endpoint, closing all inbound and outbound channels. |
| ExecuteRequest | Performs a direct, point-to-point request/response transaction with another CFX Endpoint. |
| ExecuteRequestAsync | Performs a direct, point-to-point request/response transaction with another CFX Endpoint. |
| GetSpoolSize | Returns the total number of messages spooled for a particular |
| Open(String, Uri, X509Certificate2) | Opens and inintializes the Endpoint. This should be called only once prior to closing the endpoint. |
| Open(String, IPAddress, Int32, X509Certificate2) | Opens and inintializes the Endpoint. This should be called only once prior to closing the endpoint. |
| Publish(CFXEnvelope) | Publishes a CFX message. The message will be transmitted to all publish channels. |
| Publish(CFXMessage) | Publishes a CFX message. A CFX envelope will be automatically generated for your message. The message will be transmitted to all publish channels. |
| PublishMany(IEnumerableCFXEnvelope) | Publishes multiple CFX messages at one time. The messages will be transmitted to all publish channels. |
| PublishMany(IEnumerableCFXMessage) | Publishes multiple CFX messages at one time. CFX envelopes will be automatically generated for your messages. The messages will be transmitted to all publish channels. |
| PublishManyToChannel(IEnumerableCFXEnvelope, AmqpChannelAddress) | Publishes a collection of CFX envelopes to the specified channel. |
| PublishManyToChannel(IEnumerableCFXMessage, AmqpChannelAddress) | Publishes a collection of CFX messages to the specified channel. CFX envelopes will be automatically generated for each of your messages. |
| PublishManyToMessageSource | Publishes multiple messages to a message source. |
| PublishToChannel(CFXEnvelope, AmqpChannelAddress) | Publishes a CFX envelope to the specified channel. |
| PublishToChannel(CFXMessage, AmqpChannelAddress) | Publishes a CFX message to the specified channel. A CFX envelope will be automatically generated for your message. |
| PublishToMessageSource | Publishes a single message to a message source. |
| PurgeAllSpools | Permanently deletes all spooled messages from all Publish channels associated with this endpoint. |
| PurgeMessageSource | Purges all queued messages for the given message source. |
| PurgeSpool | Permanently deletes all spooled messages from the specified Publish channel. |
| TestChannel | Tests if the specified network address is capable of establishing an AMQP connection from this endpoint. |
| TestPublishChannel | Tests if the specified network address and AMQP target address is capable of receiving messages published from this endpoint. |
| TestSubscribeChannel | Tests if this endpoint is capable of subscribing to and receiving message from the specified network address and AMQP source address. |
Events| Name | Description | |
|---|---|---|
 | OnCFXMessageReceived | Event that fires whenever a CFX message is received from a subscription type channel. |
| OnCFXMessageReceivedFromListener | Event that fires whenever a CFX message is received from a listener type channel. |
| OnConnectionEvent | Event that fires whenever a publish or subscription type connection is established, interrupted, or disconnected. The AmqpCFXEndpoint class will continuously attempt to reconnect any connection that has been interrupted. |
| OnMalformedMessageReceived | Event that fires whenever a message is received that is not a valid, properly formatted CFX Message |
| OnRequestReceived | Event that fires whenever a request type CFX message is received by this Endpoint from another Endpoint. Implement this event with your own handler to process incoming point-to-point Request / Response type CFX messages. |
| OnValidateCertificate | Implement this event with your own handler if you wish to validate the server certificate used for secure, encrypted, AMQPS communications. |
See Also