TIBCO FTL®

Properties | List of all members
TIBCO.FTL.IInboxSubscriber Interface Reference

Inbox subscribers receive one-to-one messages. More...

Inheritance diagram for TIBCO.FTL.IInboxSubscriber:

## Properties
IInbox | Inbox`[get]`
| Get the inbox object from an inbox subscriber. More...

## Additional Inherited Members
Public Member Functions inherited from TIBCO.FTL.ISubscriber
void | Acknowledge (IMessage[] messages)
| Explicitly acknowledge a batch of messages. More...

## Detailed Description

Inbox subscribers receive one-to-one messages.

InboxSubscriber inherits most of its behavior from ISubscriber, with the following differences:

- Each inbox subscriber contains a unique inbox object. Programs can obtain that inbox from the IInboxSubscriber.Inbox property, and send it in a message to other program instances. Other programs that receive the inbox object can efficiently send one-to-one messages to the inbox subscriber using the method IPublisher.SendToInbox. Disposing the inbox subscriber disposes its inbox.
- An inbox subscriber receives all messages sent (through its endpoint) to its inbox. It cannot use a content matcher to filter messages.

An inbox subscriber remains inert until you add it to an event queue.

To create an inbox subscriber object, call IRealm.CreateInboxSubscriber(string, ITibProperties). Programs must define a callback method in a class that implements the ISubscriberListener interface.

Customers do not implement this interface.

## Property Documentation

## ◆ Inbox

IInbox TIBCO.FTL.IInboxSubscriber.Inbox
| get

Get the inbox object from an inbox subscriber.

Messages can carry this inbox object to other programs (see IMessage.SetInbox(string, IInbox)). Programs that receive that inbox can send a stream of one-to-one messages to the inbox subscriber.

Your program must not explicitly `Dispose` the inbox because the inbox subscriber owns it.

Returns
  an inbox object