TIBCO FTL®
Public Member Functions | List of all members
TIBCO.FTL.IPublisher Interface Reference

Publisher objects send messages. More...

Inheritance diagram for TIBCO.FTL.IPublisher:

Public Member Functions

void Send (IMessage message)
 Send a message, one-to-many. More...
 
void Send (IMessage[] messages)
 Send messages (one-to-many) from an array of messages. More...
 
void Send (IMessage[] messages, int count)
 Send a subset of messages from an array of messages. More...
 
void SendReply (IMessage reply, IMessage request)
 Upon receiving a request message, send a reply message to the requester. More...
 
IMessage SendRequest (IMessage request, double timeout)
 Send a request and wait for a reply. More...
 
void SendToInbox (IInbox inbox, IMessage message)
 Send an inbox message to an inbox. More...
 

Detailed Description

Publisher objects send messages.

A publisher object realizes the message-sending functionality of an endpoint within a program.

A publisher object encapsulates all the information that a program needs to send a stream of messages. Publisher objects use the transport and format resources associated with an endpoint (as defined in the realm).

Programs can use a publisher to send messages one-to-many, or one-to-one.

To create a publisher object, call IRealm.CreatePublisher(string). Programs must IDisposable.Dispose publisher objects to reclaim resources.

Customers do not implement this interface.

Member Function Documentation

void TIBCO.FTL.IPublisher.Send ( IMessage  message)

Send a message, one-to-many.

Parameters
messageThe method sends this message.
void TIBCO.FTL.IPublisher.Send ( IMessage[]  messages)

Send messages (one-to-many) from an array of messages.

The application sends all the messages from the array, in order.

Sending an array of messages eliminates the overhead cost of a separate call for each message.

Parameters
messagesThe method sends all the messages from this array.
void TIBCO.FTL.IPublisher.Send ( IMessage[]  messages,
int  count 
)

Send a subset of messages from an array of messages.

The application sends count messages from the array, in order.

Sending an array of messages eliminates the overhead cost of a separate call for each message.

Parameters
messagesThe method sends count messages from this array.
countSupply the number of messages to send.
void TIBCO.FTL.IPublisher.SendReply ( IMessage  reply,
IMessage  request 
)

Upon receiving a request message, send a reply message to the requester.

Parameters
replyThe reply message to send.
requestSend a reply to this inbound request message.
IMessage TIBCO.FTL.IPublisher.SendRequest ( IMessage  request,
double  timeout 
)

Send a request and wait for a reply.

Parameters
requestThe request message to send.
timeoutThe maximum time (in seconds) to wait for a reply.
Returns
A received reply message.
void TIBCO.FTL.IPublisher.SendToInbox ( IInbox  inbox,
IMessage  message 
)

Send an inbox message to an inbox.

Because inbox messages do not trigger the content matchers of other subscribers on the endpoint, they are an efficient way to target a message to a specific destination. For example, you might use an inbox message to query a specific data source, or to reply to a query.

Parameters
inboxThe method sends the message to this inbox.
messageThe method sends this message.
See Also
IRealm.CreateInboxSubscriber(string), IMessage.GetInbox(string)