StreamLink.NET
Caplin.StreamLink Namespace
StreamLink.NETCaplin.StreamLink
All Caplin StreamLink.NET functionality is located within this top-level namespace.

The Caplin.StreamLink namespace contains interfaces and definitions that permit an API user to create StreamLink interfaces and connect to servers.

Declaration Syntax
C#Visual BasicVisual C++
namespace Caplin.StreamLink
Namespace Caplin.StreamLink
namespace Caplin.StreamLink
Types
All TypesClassesInterfacesEnumerations
IconTypeDescription
ConnectionStatus
This enumeration defines the states of a StreamLink connection. When the connection state changes, a IConnectionStatusEvent event is raised on any supplied IConnectionListener listeners. The IConnectionStatusEvent.Status has the property Status that contains one of these state values.

IConnectionConfiguration
Provides access to information about how the connection to the Liberator is configured.

IConnectionListener
This interface allows applications to receive events about the state of StreamLink's connection to the Liberator, the state of any data services the Liberator is using, and the state of the DataSources providing the data services. You must define a class that implements this interface and register it with StreamLink using the AddConnectionListener(IConnectionListener) method of IStreamLinkProvider.

IConnectionStatusEvent
Provides information about an event concerning the status of the Liberator connection.

ICredentials
Encapsulates authentication information used to log in to a Liberator server.

If your StreamLink application does not use the simple [!:PasswordCredentialsProvider] class supplied with StreamLink .NET, you must define a class that implements the ICredentials interface and a class that implements the ICredentialsProvider interface.


ICredentialsProvider
This interface defines how to provide the user credentials that StreamLink uses to log in to a Liberator server.

If your StreamLink application does not use one of the credentials provider classes supplied with StreamLink .NET (such as CredentialsProvider or PasswordCredentialsProvider), you must define your own class that implements this interface, along with an implementation of the ICredentials interface (which must be returned by the Credentials property of the ICredentialsProvider).


IExceptionHandler
Definition of the interface that receives exceptions generated by StreamLink.NET on non-user controlled threads.

IField
Provides access to the name and value of fields.

ILogger
Definition of the interface that will receive logging messages from StreamLink.NET.

IParametersFactory
A factory for creating the parameters required when issuing commands and subscription requests to StreamLink.

IServiceStatusEvent
Contains information about the change in status of a data service to which StreamLink is connected via the Liberator.

ISourceStatusEvent
Contains information about a change in the status of a DataSource to which StreamLink is connected via the Liberator.

IStatistics
Gives access to Latency related statistics

IStreamLinkConfiguration
Provides access to information about StreamLink’s configuration.

IStreamLinkProvider
This interface provides the main StreamLink.NET API, allowing the application to control interactions with the server, including subscribing to data and controlling connections.

ServiceStatus
Identifies the status of a data service.

SourceStatus
Identifies the status of a DataSource.

StreamLink
This is the main class within the Caplin StreamLink .NET API. Your application must create an instance of this class to use the functionality provided by StreamLink.

SubjectType
The possible subject (data item) types supported by StreamLink.

Remarks

The StreamLink class is the main entry point of StreamLink.NET. To use StreamLink.NET the API user must create a new instance of the StreamLink object. Each instance of a StreamLink class represents a streaming connection to a Liberator.