Class ConnectionInfo

Namespace

VAST.Network

Assembly

VAST.Network.dll

Represents metadata and authorization information for a network connection to the streaming server.

public class ConnectionInfo

Inheritance

object

ConnectionInfo

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConnectionInfo()

public ConnectionInfo()

Properties

AdditionalInfo

Gets or sets additional information about the connection. This is a protocol specific data and, for example, for HTTP based connection contains a list of request headers. Could be null.

public object AdditionalInfo { get; set; }

Property Value

object

AdditionalParameters

Gets or sets optional parameters for the publishing point which will be created after successful validation.

public PublishingPointParameters AdditionalParameters { get; set; }

Property Value

PublishingPointParameters

ConnectionId

Gets or sets the unique identifier of the connection.

public Guid ConnectionId { get; set; }

Property Value

Guid

ConnectionType

Gets or sets the type of the connection (publisher, client, or undetermined).

public ConnectionType ConnectionType { get; set; }

Property Value

ConnectionType

EndPoint

Gets or sets the connected end point.

public IPProtoEndPoint EndPoint { get; set; }

Property Value

IPProtoEndPoint

InboundUri

Gets or sets the inbound URI of the connection.

public string InboundUri { get; set; }

Property Value

string

IsValid

Gets or sets a value indicating whether the connection is valid or not. Either IsValid or IsValidAwaiter must be set by a user in the Authorize event handler but not both of them.

public bool? IsValid { get; set; }

Property Value

bool?

IsValidAwaiter

Gets or sets a task to get an authorization result from client code. Should be used in case an authorization process takes significant time and/or uses asynchronous operations. Either IsValid or IsValidAwaiter must be set by a user in the Authorize event handler but not both of them.

public Task<bool> IsValidAwaiter { get; set; }

Property Value

Task<bool>

PublishingPath

Gets or sets the publishing point path extracted from the end point URI or by any other means (depends on the protocol).

public string PublishingPath { get; set; }

Property Value

string

SocketError

Gets or sets the socket error received on disconnection.

public ExtendedSocketError SocketError { get; set; }

Property Value

ExtendedSocketError

UserSource

Gets or sets a custom source object handled by the user.

public INetworkSource UserSource { get; set; }

Property Value

INetworkSource