StreamLink.NET  7.1.6-7.1.6-3952-ee12172
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Public Member Functions | Properties | List of all members
Caplin.StreamLink.IStreamLinkConfiguration Interface Reference

Interface that allows the configuration of StreamLink to be defined programmatically. More...

Public Member Functions

void AddCustomAttribute (string key, string value)
 Sets custom attributes. These are recorded in StreamLink log files More...
 
void AddLiberatorUrlGroup (params string[] urls)
 Adds a group of URLs that define possible Liberator connections. More...
 
void SetReconnectCycleDelays (params int[] delays)
 Delay in milliseconds before retrying, after failing to connect with all available connection options. More...
 

Properties

string ApplicationId [set]
 Sets the application identifier. This is used by the Caplin Platform to distinguish StreamLink requests from different client applications. It is recorded in StreamLink log files, and is used by Liberator in monitoring software licence compliance and by the Caplin Permissioning Service to restrict the applicability of permissioning rules to specific applications. More...
 
int ClockOffsetInterval [set]
 Sets the interval between successive calculations of clock offset value(default 10000 milliseconds). For more information, see the clock_offset_interval JSON attribute in StreamLinkFactory. More...
 
int ClockOffsetWindow [set]
 Sets the time a calculated clock offset is valid for use in producing statistics (default 120000 milliseconds). For more information, see the clock_offset_window JSON attribute in StreamLinkFactory. More...
 
ReadOnlyDictionary< string,
string > 
CustomAttributes [get]
 Custom attributes as a read only dictionary
 
bool DisablePolling [set]
 Set to true if you don't want to use polling connection when the rttp(s) protocol is specified. More...
 
int HttpPadLength [set]
 Sets the amount of padding to use when establishing a streaming connection using the http(s):// connection type. Increasing this value can help should there be a buffering network component between the client and the Liberator. More...
 
int HttpTimeout [set]
 Sets the time allowed for an HTTP Request to finish successfully before StreamLink times out (default 3000 milliseconds). More...
 
int InactivityTimeout [set]
 Maximum time in milliseconds that Liberator waits to receive messages from this StreamLink client. More...
 
IJsonHandler JsonHandler [set]
 
IKeymasterCookieProvider KeymasterCookieProvider [set]
 
string KeymasterHttpPass [set]
 Corresponding password to access the KeyMaster URL. More...
 
string KeymasterHttpUser [set]
 Username to access the KeyMaster URL. More...
 
int KeymasterPollInterval [set]
 Interval in milliseconds at which StreamLink will poll KeyMaster (on the KeyMaster poll URL) to keep the KeyMaster session open. More...
 
IKeymasterPollResponseListener KeymasterPollResponseListener [set]
 Sets a IKeymasterPollResponseListener to receive information about responses to keep-alive requests made to KeyMaster. More...
 
string KeymasterPollUrl [set]
 Sets the URL that StreamLink uses to check the connection to KeyMaster every KeyMaster poll interval milliseconds. More...
 
string KeymasterRttpUser [set]
 Username that KeyMaster will generate a one-use token for. Use of this configuration option is strongly discouraged. Your KeyMaster instance should determine this value from the keymaster_httpuser option. More...
 
string KeymasterUrl [set]
 Sets the URL of KeyMaster for secure authentication of Liberator login requests. More...
 
int LatencyInterval [set]
 Sets the time between successive calculations of average latency (default 10000 milliseconds). For more information, see the latency_interval JSON attribute in StreamLinkFactory. More...
 
int LatencyWindow [set]
 Sets the time for which a calculated latency value is valid for use in producing statistics (default 120000 milliseconds). For more information, see the latency_window JSON attribute in StreamLinkFactory. More...
 
ILiberatorUrlProvider LiberatorUrlProvider [set]
 
int LogBufferSize [set]
 
int MaximumConnectionLimit [set]
 Sets the amount of allowed connections, with a minimum value of 2 More...
 
string Password [set]
 Sets the Liberator login password to use if logins are not being managed by KeyMaster or a custom ICredentialsProvider. More...
 
int PollInterval [set]
 Sets the time interval in milliseconds between polls of the Liberator. More...
 
IWebProxy Proxy [set]
 Sets the WebProxy to be used for all connection types. More...
 
int ReconnectDelay [set]
 Delay in milliseconds before retrying, after failing to connect with all available connection options (default 1000 milliseconds). More...
 
int RequestTimeout [set]
 Time in milliseconds allowed for the response to each command before StreamLink reconnects to the Liberator. More...
 
string Username [set]
 Sets the Liberator login user-name to use if logins are not being managed by KeyMaster or a custom ICredentialsProvider. More...
 

Detailed Description

Interface that allows the configuration of StreamLink to be defined programmatically.

You can obtain an instance of this interface by calling StreamLinkFactory.CreateConfiguration().

Member Function Documentation

void Caplin.StreamLink.IStreamLinkConfiguration.AddCustomAttribute ( string  key,
string  value 
)

Sets custom attributes. These are recorded in StreamLink log files

<key>The attribute name</key>

The attribute value

void Caplin.StreamLink.IStreamLinkConfiguration.AddLiberatorUrlGroup ( params string[]  urls)

Adds a group of URLs that define possible Liberator connections.

For more information on defining Liberator URL groups see IStreamLinkFactory and the "Resilience, failover, and load balancing" section of the StreamLink Overview.

Parameters
urlsA set of URLs defining a Liberator connection group.
void Caplin.StreamLink.IStreamLinkConfiguration.SetReconnectCycleDelays ( params int[]  delays)

Delay in milliseconds before retrying, after failing to connect with all available connection options.

The entries are treated as a backoff where each entry is used once and the last entry is the delay that will keep getting used forever (default 2000 milliseconds).

Property Documentation

string Caplin.StreamLink.IStreamLinkConfiguration.ApplicationId
set

Sets the application identifier. This is used by the Caplin Platform to distinguish StreamLink requests from different client applications. It is recorded in StreamLink log files, and is used by Liberator in monitoring software licence compliance and by the Caplin Permissioning Service to restrict the applicability of permissioning rules to specific applications.

The application identifier.

int Caplin.StreamLink.IStreamLinkConfiguration.ClockOffsetInterval
set

Sets the interval between successive calculations of clock offset value(default 10000 milliseconds). For more information, see the clock_offset_interval JSON attribute in StreamLinkFactory.

The clock offset interval in milliseconds.

int Caplin.StreamLink.IStreamLinkConfiguration.ClockOffsetWindow
set

Sets the time a calculated clock offset is valid for use in producing statistics (default 120000 milliseconds). For more information, see the clock_offset_window JSON attribute in StreamLinkFactory.

The clock offset window in milliseconds.

bool Caplin.StreamLink.IStreamLinkConfiguration.DisablePolling
set

Set to true if you don't want to use polling connection when the rttp(s) protocol is specified.

Set to true to disable polling connection in rttp(s) protocol.

int Caplin.StreamLink.IStreamLinkConfiguration.HttpPadLength
set

Sets the amount of padding to use when establishing a streaming connection using the http(s):// connection type. Increasing this value can help should there be a buffering network component between the client and the Liberator.

The length of the padding

int Caplin.StreamLink.IStreamLinkConfiguration.HttpTimeout
set

Sets the time allowed for an HTTP Request to finish successfully before StreamLink times out (default 3000 milliseconds).

The timeout period in milliseconds.

int Caplin.StreamLink.IStreamLinkConfiguration.InactivityTimeout
set

Maximum time in milliseconds that Liberator waits to receive messages from this StreamLink client.

If the Liberator fails to receive a message from StreamLink within this interval, it disconnects the session and waits for a reconnection attempt.

The clock offset between Liberator and StreamLink is determined periodically by StreamLink sending a message to the Liberator. It is therefore recommended that this option should be configured to be greater than the ClockOffset configuration value. If it is configured to be smaller, more reconnections than required will take place.

Note: This feature is only supported by Liberator 6.0 and newer. To determine if your Liberator installation supports this feature, refer to the Liberator's release note.

The inactivity period in milliseconds.

IJsonHandler Caplin.StreamLink.IStreamLinkConfiguration.JsonHandler
set

Sets a JsonHandler that will be used to parse and patch JSON objects.

The class that implements the IJsonHandler interface.

IKeymasterCookieProvider Caplin.StreamLink.IStreamLinkConfiguration.KeymasterCookieProvider
set

Sets a KeymasterCookieProvider that will provide the cookies used when making KeyMaster connections.

The class that will provide the set of cookies.

string Caplin.StreamLink.IStreamLinkConfiguration.KeymasterHttpPass
set

Corresponding password to access the KeyMaster URL.

The Keymaster Http Password

Setting this property (and the associated KeymasterHttpUser allows StreamLink to perform HTTP level authentication against the application server that hosts the KeyMaster.

>

string Caplin.StreamLink.IStreamLinkConfiguration.KeymasterHttpUser
set

Username to access the KeyMaster URL.

The Keymaster Http Username

Setting this property (and the associated KeymasterHttpPass allows StreamLink to perform HTTP level authentication against the application server that hosts the KeyMaster.

>

int Caplin.StreamLink.IStreamLinkConfiguration.KeymasterPollInterval
set

Interval in milliseconds at which StreamLink will poll KeyMaster (on the KeyMaster poll URL) to keep the KeyMaster session open.

The interval in at which StreamLink will poll KeyMaster (default 600000 milliseconds).

IKeymasterPollResponseListener Caplin.StreamLink.IStreamLinkConfiguration.KeymasterPollResponseListener
set

Sets a IKeymasterPollResponseListener to receive information about responses to keep-alive requests made to KeyMaster.

The KeymasterPollResponseListener.

string Caplin.StreamLink.IStreamLinkConfiguration.KeymasterPollUrl
set

Sets the URL that StreamLink uses to check the connection to KeyMaster every KeyMaster poll interval milliseconds.

The URL that StreamLink uses to check the connection.

string Caplin.StreamLink.IStreamLinkConfiguration.KeymasterRttpUser
set

Username that KeyMaster will generate a one-use token for. Use of this configuration option is strongly discouraged. Your KeyMaster instance should determine this value from the keymaster_httpuser option.

The Keymaster Rttp Username

string Caplin.StreamLink.IStreamLinkConfiguration.KeymasterUrl
set

Sets the URL of KeyMaster for secure authentication of Liberator login requests.

The KeyMaster URL

int Caplin.StreamLink.IStreamLinkConfiguration.LatencyInterval
set

Sets the time between successive calculations of average latency (default 10000 milliseconds). For more information, see the latency_interval JSON attribute in StreamLinkFactory.

The latency interval in milliseconds.

int Caplin.StreamLink.IStreamLinkConfiguration.LatencyWindow
set

Sets the time for which a calculated latency value is valid for use in producing statistics (default 120000 milliseconds). For more information, see the latency_window JSON attribute in StreamLinkFactory.

The latency window in milliseconds.

ILiberatorUrlProvider Caplin.StreamLink.IStreamLinkConfiguration.LiberatorUrlProvider
set

Sets a ILiberatorUrlProvider that will be used to get the next Liberator URL to connect to.

The class that will provide the name of the next Liberator URL to try.

If this option is set then it will override any urls added via the addLiberatorUrlGroup method.

int Caplin.StreamLink.IStreamLinkConfiguration.LogBufferSize
set

Sets the size of the log buffer to be used in Streamlink. If the size is less than or equal to 0, the log buffer will be disabled. (default -1).

The size of the log buffer to be used

The log buffer can be used by your application to retrieve recent logging information. This logging information can be essential for diagnosing connectivity and other application issues.

int Caplin.StreamLink.IStreamLinkConfiguration.MaximumConnectionLimit
set

Sets the amount of allowed connections, with a minimum value of 2

The maximum number of allowed connections

This property is available as a convenience. Internally, setting this property results in the system level property ServicePointManager.DefaultConnectionLimit

string Caplin.StreamLink.IStreamLinkConfiguration.Password
set

Sets the Liberator login password to use if logins are not being managed by KeyMaster or a custom ICredentialsProvider.

The Liberator login password.

int Caplin.StreamLink.IStreamLinkConfiguration.PollInterval
set

Sets the time interval in milliseconds between polls of the Liberator.

This only applies to HTTP polling type connections (see 'RTTP connection types' in the document StreamLink Overview).

The poll interval.

IWebProxy Caplin.StreamLink.IStreamLinkConfiguration.Proxy
set

Sets the WebProxy to be used for all connection types.

The web proxy used for the connection

By default, StreamLink will use the global proxy configuration in Windows, however your application may be deployed in an environment where the Liberator can not be accessed via this default proxy.

int Caplin.StreamLink.IStreamLinkConfiguration.ReconnectDelay
set

Delay in milliseconds before retrying, after failing to connect with all available connection options (default 1000 milliseconds).

The reconnect delay in milliseconds.

int Caplin.StreamLink.IStreamLinkConfiguration.RequestTimeout
set

Time in milliseconds allowed for the response to each command before StreamLink reconnects to the Liberator.

The request timeout period in milliseconds.

string Caplin.StreamLink.IStreamLinkConfiguration.Username
set

Sets the Liberator login user-name to use if logins are not being managed by KeyMaster or a custom ICredentialsProvider.

The Liberator login user-name.


Generated on Tue Apr 28 2020 06:25:30 for StreamLink.NET