StreamLink.NET
8.0.3-8.0.3-1239-180a512
|
The interfaces, classes and enumerators within this package provide the functionality of StreamLink. More...
Namespaces | |
package | Alerts |
The classes within this package provide the functionality of StreamLink alerts | |
Classes | |
class | BaseConnectionListener |
Adapter class implementing the IConnectionListener methods More... | |
class | BaseSubscriptionListener |
Adapter class implementing the ISubscriptionListener methods More... | |
class | ConsoleLogListener |
Utility class to aid debugging. More... | |
class | ContainerFilterFactory |
A factory for creating FilterExpressions for use in the IContainerSubscriptionParameters select method. More... | |
interface | IAdvancedConfiguration |
This interface provides access to advanced features of the StreamLink library. More... | |
interface | IChannel |
Represents a channel to a subject on the Liberator. More... | |
interface | IChannelListener |
Interface for receiving updates on the channel from the Liberator. More... | |
interface | IChatEvent |
Provides information about updates to a chat subject. More... | |
interface | ICommandErrorEvent |
Provides error information for commands. More... | |
interface | ICommandListener |
Defines the interface that you should implement to receive information on the result of a command. More... | |
interface | ICommandParameters |
Interface that defines parameters for a ICommandSubscription. More... | |
interface | ICommandResultEvent |
Provides result information for commands. More... | |
interface | ICommandResultListener |
Defines the interface that you should implement to receive information on the result of a command. More... | |
interface | ICommandSubscription |
Stored information on the subscription and lets you unpersist the command. More... | |
interface | IConnectionCurrentState |
interface | IConnectionListener |
Defines the interface for receiving information about changes in the state of the StreamLink connection, the data services available from the Liberator, and the DataSources that are normally connected to the Liberator. More... | |
interface | IConnectionStatusEvent |
Provides information about a change in status of the connection to the Liberator. More... | |
interface | IContainerElement |
Representation of a subject that is within a container. More... | |
interface | IContainerEvent |
Represents an update to a container subject. More... | |
interface | IContainerModel |
This interface defines a model that represents a container. You need to implement it to process the updateModel callback in IContainerEvents. More... | |
interface | IContainerSubscriptionParameters |
Defines the parameters used for Container subscriptions. To create an instance of ContainerSubscriptionParameters call the IStreamLink.CreateContainerSubscriptionParameters method. More... | |
interface | ICredentials |
Encapsulates authentication information used to log in to a Liberator server. More... | |
interface | ICredentialsProvider |
This interface defines how to provide the user credentials that StreamLink uses to log into a Liberator server. More... | |
interface | ICredentialsReceiver |
Interface that your custom implementation of ICredentialsProvider must call to provide credential information to StreamLink. More... | |
interface | IDataEvent |
Provides access to fundamental information about subscription events relating to changes in data, such as the subject and the type of event that has occurred. More... | |
interface | IDirectoryChangeElement |
Provides information about a change to a directory element. More... | |
interface | IDirectoryEvent |
Provides information about a change to a directory. More... | |
interface | IDiscardHandler |
interface | IFilterExpression |
Interface that represents a filter expression. More... | |
interface | IFreeFormSubscriptionParameters |
A FreeFormSubscriptionParameters instance allows you to pass parameters to subscriptions for subject types that are not records or containers. More... | |
interface | IHttpHeaderProvider |
interface | IJsonChannel |
Represents a JSON channel to a subject on the Liberator. More... | |
interface | IJsonChannelListener |
Interface for receiving updates on the JSON channel from the Liberator. More... | |
interface | IJsonDiscardHandler |
interface | IJsonEvent |
Provides information about a JSON message. More... | |
interface | IJsonHandler |
interface | IJsonProvider |
interface | IJsonProviderHandle |
interface | IJsonPublisher |
interface | IJsonSubscriptionParameters |
Defines the parameters used for Json subscriptions. More... | |
interface | IKeymasterCookieProvider |
interface | IKeymasterHttpHeaderProvider |
interface | IKeymasterPollResponseListener |
Defines the interface that should be implemented by the application to receive KeyMaster keep alive Responses. More... | |
interface | ILiberatorUrlProvider |
interface | ILogger |
Allows StreamLink log messages to be written to the destination of your choice. More... | |
interface | ILogInfo |
Stores log information including message and level of a log entry. More... | |
interface | ILogListener |
Interface for receiving log messages from the StreamLink application. More... | |
interface | INewsEvent |
Provides information about a news headline update. More... | |
interface | IPageElement |
Provides information about a single text change for the given row and column in a Page. More... | |
interface | IPageEvent |
Provides information about a change to data in a Page. More... | |
interface | IPermissionEvent |
Provides information about a change to permission data. More... | |
interface | IPublisher |
interface | IRawSocketFactory |
This interface allows a user application to specify a connection strategy to use when creating Type 1 (direct socket) connections. For example, to negotiate a SOCKS proxy or other custom tunneling requirements. More... | |
interface | IRecordDiscardHandler |
interface | IRecordProvider |
interface | IRecordProviderHandle |
interface | IRecordPublisher |
interface | IRecordSubscriptionParameters |
Defines the parameters used for Record subscriptions. More... | |
interface | IRecordType1Event |
Provides information about a change to type 1 data (fieldname and data pairs) in a record. More... | |
interface | IRecordType2Event |
Provides information about a change to type 2 data in a record. More... | |
interface | IRecordType3Event |
Provides information about a change to type 3 data in a record. More... | |
interface | IServiceStatusEvent |
Provides information about the change in status of a data service to which StreamLink is connected via the Liberator. More... | |
interface | ISourceStatusEvent |
Provides information about the change in status of an Integration Adapter to which StreamLink is connected via the Liberator. More... | |
interface | IStatisticsEvent |
Provides access to the statistics relating to an instance of StreamLink. More... | |
interface | IStoryEvent |
Provides information about a change to story data in a Story. More... | |
interface | IStreamLink |
Defines the StreamLink interface. More... | |
interface | IStreamLinkConfiguration |
Interface that allows the configuration of StreamLink to be defined programmatically. More... | |
interface | ISubscription |
Represents a subscription to a subject on the Liberator. More... | |
interface | ISubscriptionErrorEvent |
Provides information about a subscription error. More... | |
interface | ISubscriptionListener |
Interface for receiving updates to subscribed data from the Liberator. More... | |
interface | ISubscriptionParameters |
The base interface for defining parameters that apply to Subscriptions. More... | |
interface | ISubscriptionStatusEvent |
Provides information about a change in the state of a subscription. More... | |
interface | IWebRequestParameters |
Contains the parameters needed to call a specific Liberator web module. More... | |
class | LogLevel |
Enumeration that represents the available logging levels. More... | |
class | StreamLinkFactory |
Factory that creates StreamLink instances. More... | |
class | STuple |
The interfaces, classes and enumerators within this package provide the functionality of StreamLink.
Enumeration that defines the type of the IChatEvent.
The ChatEventType can be obtained by calling getUpdateType() on a IChatEvent.
Enumeration defining the errors that can occur for a command.
You can obtain the CommandErrorType by calling getError() on a ICommandErrorEvent.
Enumeration that defines the state of a StreamLink connection to a Liberator.
You can obtain the ConnectionState by calling getConnectionState on a IConnectionStatusEvent.
Although hints regarding possible transitions between ConnectionStates are given, you should not imply that this is a strict contract because network conditions may cause undocumented transitions.
The generalised sequence after calling streamlink.connect() is as follows: CONNECTING -> CONNECTED -> LOGGEDIN. At any point in time the connection could be lost which would raise the LOST, at this point StreamLink would attempt to connect again to a Liberator server, starting the sequence once more.
With this in mind, it is possible to map these onto a "traffic light" component indicating connection health using the following mappings:
Enumerator | |
---|---|
DISCONNECTED |
Disconnected from the Liberator. When this state is raised by the StreamLink library ** all subscriptions have removed. StreamLink will not perform any activity until you
|
CONNECTING |
A connection attempt is in progress. If the connection attempt is successful, a ** CONNECTED state will be raised, if the connection fails, the FAILED
|
FAILED |
A connection attempt has failed. StreamLink will attempt to connect to a Liberator on ** the configured server list. |
CONNECTED |
A network connection has been established to the Liberator. StreamLink will now attempt ** to log in to the Liberator session. |
RETRIEVINGCREDENTIALS |
StreamLink is attempting to obtain a set of credentials to log in to the server. |
CREDENTIALSRETRIEVED |
StreamLink has successfully retrieved the credentials. |
CREDENTIALSRETRIEVALFAILED |
StreamLink has failed to retrieve the credentials. |
LOGGEDIN |
The client is now logged into the Liberator. In this state it is possible for ** StreamLink applications to receive subscription updates and receive responses to
|
LOGINFAILED |
The client could not login to the Liberator. StreamLink will not perform any ** more connection attempts and will switch to the DISCONNECTED state. |
EJECTED |
The client has been ejected from the Liberator. StreamLink will not perform any ** more connection attempts and will switch to the DISCONNECTED state. |
LOST |
The connection to the Liberator has been lost. StreamLink will attempt to connect and ** establish a new session with a configured Liberator. |
RECONNECTED |
The Liberator session has been reconnected. This should be treated as an informational ** event, StreamLink will switch to the LOGGEDIN state to simplify implementation
|
UNREACHABLE |
A connection to the Liberator is not possible due to no network being available. |
PAUSED |
The connection has been paused by the application. This state is a direct result of ** the application causing IStreamLink.Pause. StreamLink is
|
Enumeration that defines the reasons for an error being raised in a ISubscriptionErrorEvent or a ICommandErrorEvent.
Enumeration that represents a particular logical operation.
Enumeration that represents the operators that are available for a FieldFilterExpression.
Enumeration that defines the reason for a failed login.
The LoginFailedReason will be provided by calling getLoginFailReason on a IConnectionStatusEvent.
Enumeration that defines the status of a Service.
The ServiceStatus will be provided by calling getServiceStatus on a IServiceStatusEvent.
The three states that are possible for a Liberator data service are:
Enumeration that defines the status of a source.
The SourceStatus will be provided by calling getSourceStatus on a ISourceStatusEvent.
Enumerator | |
---|---|
DOWN |
A source has gone up. |
UP |
A source has gone down. |
Enumeration that represents the available subject types.
The SubjectType can be obtained by calling getType() on a IContainerElement or IDirectoryChangeElement.
It is also a parameter to createSubject() in IStreamLink.
Enumeration which represents the errors that can occur for a subject.
The SubscriptionErrorType will be provided on a onSubscriptionError callback to a ISubscriptionListener.
Enumeration that defines the status of a subject.
The SubscriptionStatusType will be provided by calling getStatus() on a ISubscriptionStatusEvent.
Enumeration that defines the available throttle levels and throttle commands.
A ThrottleCommand is passed as a parameter to the throttleSubject() and throttleEverything() methods of IStreamLink.
For an explanation of throttling, refer the Throttling section of the document StreamLink Overview.