IConnectionProvider Interface

Connection provider

Namespace: Sportradar.SDK.Common.Interfaces
Assembly: Common (in Common.dll) Version: 2.28.0.0

Syntax

public interface IConnectionProvider

The IConnectionProvider type exposes the following members.

Properties

	Name	Description
	ConnectionData	Obtain current connection data
	IsStarted	Obtain whether the connection provider is running.
	RxEnabled	Whether reading from input stream is enabled or not (i.e. input msg queue going over the high watermark should disable all RX)

Methods

	Name	Description
	Error	Obsolete. Start immediate error recovery. Usually due to an error on the upper layer.
	IsReceiveThread
	SendMessage	Deliver a protocol unit (as a string) to the server.
	Start	Start the connection provider (connects to the server and start the automatic reconnection). ConnectionData must be initialized or else an exception is thrown.
	Start(IConnectionData)	Start the connection provider (connects to the server and start the automatic reconnection).
	Stop	Stop the connection provider. Opposite of Start().
	WaitForConnection	Block and wait until the connection is established.
	WaitForConnection(TimeSpan)
	WaitForDisconnection	Block and wait until the connection is not established anymore.
	WaitForDisconnection(TimeSpan)

Events

	Name	Description
	OnAliveCheckNecessary	Invoked when the protocol requires an alive check.
	OnCommunicationError	Invoked when a communication error on the physical connection is detected
	OnConnected	Invoked when the physical connection to the server is established.
	OnDisconnected	Invoked when the physical connection to the server is dropped.
	OnMessageReceived	Invoked when a new protocol data unit in string format is received.
	OnValidDataCheckNecessary	Invoked when the protocol requires a check for valid data.