TIBCO Live Datamart client API
Types
All Types | Classes | Interfaces | Enumerations |
Name | Description | |
---|---|---|
BeginAggMarkEventArgs |
Arguments to a BeginAggMark event.
| |
BeginDeleteEventArgs |
Arguments to a BeginDelete event.
| |
BeginSnapshotEventArgs |
Arguments to a BeginSnapshot event.
| |
ConnectionBackgroundWorker |
This can be used to connect to a LiveView server in the background, trying until a successful
connection is made, until an exception occurs or until the task is canceled.
| |
ConnectionConfig |
Contains the connection parameters to be passed to an ILiveViewConnection.
| |
ConnectionEstablishedEventArgs |
Describes a ConnectionEstablishedEvent.
| |
ConnectionEventArgs |
Arguments to the Connection Event handler.
| |
ConnectionEventArgs..::..ConnectionEventType |
Describes the type of connection event being fired.
| |
ConnectionMode |
Used when creating a MultiConnectionConfig to define how it will connect to the servers.
| |
ConnectionState |
The status of this connection
| |
OrderDefinition..::..Direction |
Defines the available sorting directions.
| |
EndAggMarkEventArgs |
Arguments to an EndAggMark event.
Note that for events of this type, the Tuple property
will be null.
| |
EndDeleteEventArgs |
Arguments to a EndDelete event.
| |
EndSnapshotEventArgs |
Arguments to a EndSnapshot event.
| |
EventBasedQueryResult |
This type of QueryResult exposes the low-level events received from
the LiveView server. This will offer more control and better performance than
the ObservableQueryResult class, at the loss of convenience.
Note that the event handlers configured should return quickly. In some situations, long running event handlers
can trigger heartbeat failures and/or other connection problems, particularly in the face of high data rates.
| |
ILiveViewConnection |
A client connection to a LiveView server.
| |
ILiveViewConnectionControl |
When using a LiveViewMultiConnection, this represents one of the connections.
| |
ILiveViewMultiConnection |
This is what is returned when you ask LiveViewConnectionFactory for a Multi-connection.
Note that this is also a LiveViewConnection, and it will delegate all of those calls to the current
LiveViewConnection.
| |
IObservableTuple |
This class wraps a Tuple to expose its fields as dynamic properties
(using the ICustomTypeDescriptor mechanism) to data binding.
Every Schema..::..Field in the original tuple will appear as a bona fide
property of the same name and type on the object.
Thus, if the underlying Tuple has a field called 'price', you may access its value
by using the dynamic property myObservableTuple.price.
| |
IQuery |
A Query submitted by the client. This is the client's handle to manage the query with the server.
For instance, the query can be closed at any time to release all server resources associated with it.
| |
ITable |
Metadata about a LiveView table.
| |
ITableAdminManager |
TableAdminManager is used to start and stop Tables on the server. Tables can be created, started, and
dropped only if they have no complex connections to applications or Publishers, but it is possible to obtain
ITablePublishers to a table after it is created.
It is possible to create new Aggregation-based tables, which are
tables that represent an aggregate query against an existing table.
| |
ITablePublisher |
An instance of a publisher for publishing tuples into a table. A publisher can be used to publish new or updated
tuples to a table. The server determines if the tuple is new or updated based on the table's primary key.
A publisher is created from GetTablePublisher(String) (or its overloads) where a publisher name is specified. Tuples
published will include the name of the publisher and the specified SequenceNumber for tracking and recoverability
purposes.
| |
LiveViewConnectionFactory |
Factory for creating new ILiveViewConnections.
| |
LiveViewException |
An exception thrown by the LiveView Server.
| |
LiveViewExceptionCode |
Error code (usually returned by the server) for a LiveViewException.
| |
LiveViewHttpException |
A LiveView exception caused by an HTTP error.
| |
LiveViewQueryLanguage |
Enumerates the query languages that are supported by a table.
| |
LiveViewURI |
Represents a URI suitable for use when connecting to a LiveView server. URIs take the form:
lv://[username[:password]@host[:port][?param1=value1[¶m2=value2...]]
URI can be constructed using any of the supplied constructors or via FromString(String).
| |
LiveViewURIException |
Exception related to parsing and using LiveViewURI objects.
| |
MultiConnectionConfig |
Configures a ILiveViewMultiConnection (a connection to multiple LiveView servers with failover support).
See GetConnection(MultiConnectionConfig, Boolean) | |
ObservableQueryResult |
This type of QueryResult keeps the tuples
returned by the query in a collection suitable for data binding.
This collection derives from ObservableCollection<(Of <(<'T>)>)>
and contains instances of IObservableTuple which can
be used to access individual tuple fields.
| |
ObservableTupleCollection |
Specialization of ObservableCollection that ensures CollectionChanged
notifications are sent on the correct Dispatcher thread. Otherwise, it is identical to its superclass.
| |
OrderDefinition |
Used in a QueryConfig to define the order in which you wish to receive data.
| |
QueryClosedEventArgs |
Arguments to a QueryClosed event.
| |
QueryConfig |
Holds the configuration settings of a LiveView query.
| |
QueryEventArgs |
Base class for all query-based events.
| |
QueryExceptionEventArgs |
Arguments to a QueryException event.
| |
QueryResult |
Holds the results of executing a query.
Note that the event handlers configured should return quickly. In some situations, long running event handlers
can trigger heartbeat failures and/or other connection problems, particularly in the face of high data rates.
| |
QueryConfig..::..QueryTypes |
Represents the different types of queries available.
| |
ReconnectFailedEventArgs |
Arguments to a ReconnectFailedEvent.
| |
RoughFailoverEventArgs |
Arguments to a RoughFailoverEvent.
| |
SecondaryConnectionLostEventArgs |
Arguments to a SecondaryConnectionLostEvent.
| |
SendTupleInfo |
Hold the information necessary to execute a SendTuple action.
| |
ServerCapability |
Enumerates certain capabilities that may be supported by a server.
| |
ServerVersion |
Describes the version of the connected LiveView server.
| |
SmoothFailoverEventArgs |
Arguments to a SmoothFailoverEvent.
| |
StreamBaseAPIExtensions |
Provides useful extension methods for the Tuple class.
| |
TableCapability |
Enumerates certain capabilities that may be supported by a table.
In the future, the selections might be determined not only by the
capabilities of the particular table implementation, but they might also
be determined by user privileges.
| |
QueryConfig..::..TimeWindowParams |
Represents the time window used for a query.
| |
TupleAddedEventArgs |
Arguments to a TupleAdded event.
| |
TupleEventArgs |
Base class for all LiveView tuple events.
| |
TupleRemovedEventArgs |
Arguments to a TupleRemoved event.
Note that for events of this type, the Tuple property
will be null.
| |
TupleUpdatedEventArgs |
Arguments to a TupleUpdated event.
|