TIBCO FTL®

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

Inbox objects address inbox subscribers. More...

Inheritance diagram for TIBCO.FTL.IInbox:

## Public Member Functions
IInbox | Copy ()
| Copy an inbox object. More...

## Detailed Description

Inbox objects address inbox subscribers.

Programs can insert inbox objects into message fields.

This interface defines inbox objects, and a method to copy them.

The call that creates an inbox is IRealm.CreateInboxSubscriber(string)

For calls that use inbox objects, see the classes ISubscriber and IMessage.

A program that copies an inbox object must explicitly IDisposable.Dispose it to reclaim its resources.

Note: IMessage.SetInbox(string, IInbox) copies its inbox argument into a message field. After the call returns, a program may IDisposable.Dispose the source inbox without affecting the message.

Customers do not implement this interface.

## Member Function Documentation

## ◆ Copy()

IInbox TIBCO.FTL.IInbox.Copy | ( |  | ) |

Copy an inbox object.

When an ISubscriberListener.MessagesReceived callback method gets an inbox from a field of an inbound message, the message owns that inbox object. FTL implicitly disposes that embedded inbox object when the callback returns. Programs can use this call to copy the inbox object.

Similarly, when a program gets an inbox from a subscriber object, the subscriber owns that inbox. FTL implicitly disposes that embedded inbox object when the program closes the subscriber. Programs can use this call to copy the inbox object.

Programs must explicitly IDisposable.Dispose copies.

Returns
  A copy of the Inbox object.

See also
  IMessage.GetInbox(string), IInboxSubscriber.Inbox