Namespaces
package	GROUP

Classes
class	Advisory
	Asynchronous advisory messages carry information about the operation of FTL. Programs can receive this information through subscribers on the advisory endpoint. More...

class	FTL
	The class FTL is the first entry point of an FTL program. More...

class	FTLAlreadyExistsException
	Conflict with an existing object, value or definition. More...

class	FTLClientShutdownException
	The program attempted an operation on an unusable realm object. More...

class	FTLEndOfBufferException
	End of buffer while parsing an inbound message. More...

class	FTLException
	An error occured in FTL. More...

class	FTLFormatUnavailableException
	A format required by the client program is unavailable. More...

class	FTLIllegalStateException
	An action is inconsistent with internal state. More...

class	FTLInterruptedException
	Thread internal interrupt. More...

class	FTLInvalidArgumentException
	Invalid argument (or invalid value embedded in an argument). More...

class	FTLInvalidConfigException
	Invalid or contradictory property values. More...

class	FTLInvalidFormatException
	The FTL client library encountered a message with an invalid format. More...

class	FTLInvalidTypeException
	Field datatype mismatch. More...

class	FTLInvalidValueException
	FTL internal error. More...

class	FTLIOException
	I/O error. More...

class	FTLLimitReachedException
	A resource cannot accept data because it has reached a limit. More...

class	FTLNotFoundException
	Cannot find a requested object. More...

class	FTLNotInitializedException
	The program called FTL.Close and subsequently called an FTL method that requires FTL resources. More...

class	FTLNotPermittedException
	Invalid operation (on a valid object). More...

class	FTLNotSupportedException
	Unsupported datatype or feature. More...

class	FTLNullException
	Unexpected null value. More...

class	FTLOSException
	An operating system call failed. More...

class	FTLOutOfMemoryException
	Memory allocation failed. More...

class	FTLOutOfRangeException
	A value or reference is out of range. More...

class	FTLRealmServerException
	Exception within the realm server. The client library does not throw this exception. More...

class	FTLResourceUnavailableException
	A resource required by the client program is unavailable. More...

class	FTLTimeoutException
	Internal timeout elapsed. More...

class	FTLVersionMismatchException
	Incompatible versions of FTL components. More...

interface	IContentMatcher
	Content matcher objects filter messages based on their content. More...

interface	IEventQueue
	Event queue objects hold message and timer events until listeners can process them. More...

interface	IEventTimer
	A timer object queues an event when its interval elapses. More...

interface	IInbox
	Inbox objects address inbox subscribers. More...

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

interface	ILogHandler
	Customer programs may implement this interface to process FTL log statements. More...

interface	IMessage
	Message objects contain fields with values. More...

interface	IMessageFieldRef
	Field references enable efficiency gains when accessing message fields. More...

interface	INotificationHandler
	In some situations, FTL must notify programs of conditions that preclude the use of event queues (as the communications medium). Instead of sending an advisory, FTL notifies the program through an out-of-band mechanism. More...

interface	IPublisher
	Publisher objects send messages. More...

interface	IRealm
	Realm objects contain definitions of message formats, endpoints and transport maps. More...

interface	ISubscriber
	Subscribers express interest to receive inbound messages. More...

interface	ISubscriberListener
	Message event handler. More...

interface	ITibLock
	Cooperating application programs can use locks to implement exclusive access to a map within a persistence store. More...

interface	ITibMap
	Programs can use maps to store key/value pairs in a persistence store. More...

interface	ITibMapIterator
	Map iterators iterate over the key/value pairs in a map. More...

interface	ITibProperties
	Properties objects represent a set of configuration properties (name and value pairs). More...

class	LogStream
	LogStream data messages carry logging and advisory data about FTL programs. Programs can receive the stream of logging data messages by subscribing to the logging endpoint. More...

class	MessageEnumerator
	This class implements the System.Collections.IEnumerator interface for enumerating the fields of an IMessage. When called on an IMessage, the method System.Collections.IEnumerable.GetEnumerator returns an object of this class. More...

class	Monitoring
	Monitoring data messages carry monitoring metrics data about FTL programs. Programs can receive the stream of monitoring data messages by subscribing to the monitoring endpoint. More...

class	TibDateTime
	This class represents date and time values with large range and nanosecond precision. More...

class	TimerFiredEventArgs
	Event arguments for IEventTimer.Fired events. More...

Enumerations
enum	FieldType { FieldType.OPAQUE = 0, FieldType.LONG = 1, FieldType.LONG_ARRAY = 2, FieldType.DOUBLE = 3, FieldType.DOUBLE_ARRAY = 4, FieldType.STRING = 5, FieldType.STRING_ARRAY = 6, FieldType.MESSAGE = 7, FieldType.MESSAGE_ARRAY = 8, FieldType.INBOX = 9, FieldType.DATETIME = 10, FieldType.DATETIME_ARRAY = 11, FieldType.UNKNOWN = 2048 }
	Types of fields that can occur in messages. More...

enum	RealmNotificationType { RealmNotificationType.CLIENT_DISABLED = 0 }
	Notification types available to a realm's notification handler. More...

Functions
ITibMapIterator	CreateIterator (ITibLock tiblock, ITibProperties props)

IEventTimer	CreateTimer (double interval)

void	Dispose ()

System.Collections.IEnumerator System.Collections.IEnumerable.	GetEnumerator ()

void	Send (IMessage[] messages, int count)

void	Set (String name, String value)

void	Set (string name, IMessage value)

delegate void	TimerFiredEventHandler (object sender, TimerFiredEventArgs args)
	Timer event callback. More...

	~ContentMatcher ()

	~EventTimer ()

	~Inbox ()

	~Subscriber ()

	~TibLock ()

Enumeration Type Documentation

enum TIBCO.FTL.FieldType

Types of fields that can occur in messages.

See Also: IMessage.GetFieldType(string), IMessage.GetFieldType(IMessageFieldRef)

Enumerator
OPAQUE	Opaque byte-string.
LONG	Long integer.
LONG_ARRAY	Array of long integers.
DOUBLE	Double floating-point number.
DOUBLE_ARRAY	Array of double floating-point numbers.
STRING	Character string.
STRING_ARRAY	Array of character strings.
MESSAGE	Sub-message (that is, a nested message).
MESSAGE_ARRAY	Array of sub-messages.
INBOX	Inbox.
DATETIME	DateTime.
DATETIME_ARRAY	Array of DateTime.
UNKNOWN	Unrecognized type. IMessage.GetFieldType(string) returns `UNKNOWN` to indicate that the field's type is not defined. It is not legal for programs to supply `UNKNOWN` to any API call except IMessage.GetFieldTypeString.

enum TIBCO.FTL.RealmNotificationType

Notification types available to a realm's notification handler.

See Also: IRealm.SetNotificationHandler

Enumerator

CLIENT_DISABLED

The realm server administratively disabled this client.

The current realm object no longer supports FTL functionality. Nonetheless, the program can still call Close or Dispose methods on FTL objects in the realm.

To resume FTL functionality, some programs may first call IDisposable.Dispose() on the disabled realm object, and then create a new realm object by calling FTL.ConnectToRealmServer.

Other programs may restart or exit.

Function Documentation

ITibMapIterator TIBCO.FTL.CreateIterator	(	ITibLock	tiblock,
		ITibProperties	props
	)

IEventTimer TIBCO.FTL.CreateTimer ( double interval )

void TIBCO.FTL.Dispose ( )

System.Collections.IEnumerator System.Collections.IEnumerable. TIBCO.FTL.GetEnumerator ( )

void TIBCO.FTL.Send	(	IMessage[]	messages,
		int	count
	)

void TIBCO.FTL.Set	(	String	name,
		String	value
	)

void TIBCO.FTL.Set	(	string	name,
		IMessage	value
	)

delegate void TIBCO.FTL.TimerFiredEventHandler	(	object	sender,
		TimerFiredEventArgs	args
	)

Timer event callback.

Programs implement delegate callback methods of this type to process timer events.

Programs add one or more such delegates to the IEventTimer.Fired event of IEventTimer objects.

Upon encountering a timer in its event queue, the dispatch method raises the timer's IEventTimer.Fired event; in response, .NET invokes its delegates.

Programs may IDisposable.Dispose the timer object from within this callback.

Programs must not dispatch any event queue from within any callback.

Parameters

sender	The source of the event.
args	This object contains the event data.

TIBCO.FTL.~ContentMatcher ( )

TIBCO.FTL.~EventTimer ( )

TIBCO.FTL.~Inbox ( )

TIBCO.FTL.~Subscriber ( )

TIBCO.FTL.~TibLock ( )

Namespaces

Classes

Enumerations

Functions

Enumeration Type Documentation

Function Documentation