Click or drag to resize

Connection Class

A peer-to-peer connection.
Inheritance Hierarchy
SystemObject
  FM.IceLinkSerializable
    FM.IceLinkDynamic
      FM.IceLinkConnectionBaseConnection, Stream, AudioStream, VideoStream, DataStream, DataChannel
        FM.IceLinkConnection

Namespace:  FM.IceLink
Assembly:  FM.IceLink (in FM.IceLink.dll) Version: 3.2.2.607 (3.2.2.607)

The Connection type exposes the following members.

Constructors
  NameDescription
Public methodConnection
Initializes a new instance of the Connection class.
Public methodConnection(Stream)
Initializes a new instance of the Connection class.
Public methodConnection(Stream)
Initializes a new instance of the Connection class.
Top
Properties
  NameDescription
Public propertyAudioStream
Gets the first audio stream.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyAudioStreams
Gets the audio streams.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelAudioStreams.)
Public propertyCreateDatagramSocket
Gets or sets a method that creates Datagram sockets. Optional. If not set, default OS UDP socket is used.
Public propertyCreateStreamSocket
Gets or sets a method that creates Stream sockets. Optional. If not set, default OS TCP socket is used.
Public propertyDataStream
Gets the first data stream.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyDataStreams
Gets the data streams.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelDataStreams.)
Public propertyDeadStreamTimeout
Gets or sets the amount of time (in milliseconds) to wait for connectivity checks to re-establish after they start to fail on a live connection. Defaults to 15,000.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyStatic memberDefaultLocalDtlsCertificate
Gets or sets the default local DTLS certificate.
Public propertyStatic memberDefaultLocalDtlsCertificates
Gets or sets the default local DTLS certificates.
Public propertyDtlsCipherSuites
Gets or sets the DTLS cipher suites to use. Defaults to: DtlsCipherSuite.EcdheEcdsaAes128Sha, DtlsCipherSuite.EcdheEcdsaAes128GcmSha256, DtlsCipherSuite.EcdheEcdsaAes128CbcSha256, DtlsCipherSuite.EcdheRsaAes128Sha, DtlsCipherSuite.EcdheRsaAes128GcmSha256, DtlsCipherSuite.EcdheRsaAes128CbcSha256, DtlsCipherSuite.RsaAes128Sha, DtlsCipherSuite.RsaAes128GcmSha256, DtlsCipherSuite.RsaAes128CbcSha256,
Public propertyDtlsClientVersion
Gets or sets the protocol version to use when in the DTLS client role. Defaults to Dtls10.
Public propertyDtlsServerMaxVersion
Gets or sets the maximum protocol version to allow when in the DTLS server role. Defaults to Dtls12.
Public propertyDtlsServerMinVersion
Gets or sets the minimum protocol version to allow when in the DTLS server role. Defaults to Dtls10.
Public propertyDynamicProperties
Gets or sets the dynamic properties on this instance.
(Inherited from Dynamic.)
Public propertyError
Gets or sets the error.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyGatheringState
Gets or sets the ICE gathering state.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelGatheringState.)
Public propertyHasAudio
Gets whether this connection has an audio stream.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyHasData
Gets whether this connection has a data stream.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyHasVideo
Gets whether this connection has a video stream.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyIceAddressTypes
Gets or sets the ICE address types.
Public propertyIceConnectionState
Gets or sets the ICE connection state.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelIceConnectionState.)
Public propertyIceGatherPolicy
Gets or sets the ICE gather policy.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyIcePolicy
Gets or sets policy indicating whether ICE is required (and enabled) or disabled (and not required for this connection).
Public propertyIcePortRange
Gets or sets the ICE port range.
Public propertyIceRole
Gets the ICE role.
Public propertyIceServer
Gets or sets the ICE server.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyIceServers
Gets or sets the ICE servers.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyId
Gets or sets the identifier.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Protected propertyInstance
Gets the current instance.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelInstance.)
Protected propertyIsDirty
Gets or sets a value indicating whether this instance is dirty.
(Inherited from Serializable.)
Public propertyKeepAliveInterval
Gets or sets a value indicating how many milliseconds must elapse between STUN keep-alive binding requests. Defaults to 1000.
Public propertyLocalDescription
Gets the local description.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelLocalDescription.)
Public propertyLocalDtlsCertificate
Gets or sets the local DTLS certificate.
Public propertyLocalDtlsCertificates
Gets or sets the local DTLS certificates.
Public propertyMultiplexPolicy
Gets or sets the multiplex policy.
Public propertyPrivateIPAddress
Gets or sets the private IP address of this device. If set, this will bypass the local network discovery and use this as the sole host candidate.
Public propertyPrivateIPAddresses
Gets or sets the private IP address of this device. If set, this will bypass the local network discovery and use this as the sole host candidate.
Public propertyPublicIPAddress
Gets or sets the public IP address of this device, if the NAT is known to be 1:1 and the IP address is known in advance. This should only be used in controlled server environments as an alternative to using an external STUN server.
Public propertyPublicIPAddresses
Gets or sets the public IP address of this device, if the NAT is known to be 1:1 and the IP address is known in advance. This should only be used in controlled server environments as an alternative to using an external STUN server.
Public propertyRemoteDescription
Gets the remote description.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelRemoteDescription.)
Public propertySignallingState
Gets or sets the state of the signalling.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyState
Gets or sets the state of the connection.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelState.)
Public propertyStream
Gets the first stream.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyStreams
Gets the streams.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelStreams.)
Public propertyStunBindingRequestLimit
Gets or sets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server.
Public propertyStunRequestTimeout
Gets or sets the timeout for individual Stun (and Turn) request messages in ms.
Public propertyTcpConnectTimeout
Gets or sets connection timeout for stream sockets in ms.
Public propertyTieBreaker
Gets or sets the tie breaker.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyTimeout
Gets or sets the amount of time (in milliseconds) to wait for a connection to establish before giving up and closing it. Defaults to 30,000.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyTrickleIcePolicy
Gets or sets Trickle Ice Support Policy. Cf. https://tools.ietf.org/html/draft-ietf-ice-trickle-05
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyTurnAllocateRequestLimit
Gets or sets the limit on the the number of Turn Allocate request messages when trying to establish allocation on a Turn server.
Public propertyVideoStream
Gets the first video stream.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public propertyVideoStreams
Gets the video streams.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelVideoStreams.)
Top
Methods
  NameDescription
Public methodAddIceServer
Adds an ICE server.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodAddIceServers
Adds some ICE servers.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodAddRemoteCandidate
Adds the remote candidate.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodClose
Closes this instance.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelClose.)
Public methodCreateAnswer
Creates an answer.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodCreateOffer
Creates an offer.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Protected methodDoAddRemoteCandidate
Adds the remote candidate.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelDoAddRemoteCandidate(PromiseCandidate, Candidate).)
Protected methodDoCreateAnswer
Creates an answer.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelDoCreateAnswer(PromiseSessionDescription).)
Protected methodDoCreateOffer
Creates an offer.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelDoCreateOffer(PromiseSessionDescription).)
Protected methodDoSendCachedLocalCandidates
Dispatches cached local candidates that were gathered while Connection generated session description.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelDoSendCachedLocalCandidates.)
Protected methodDoSetLocalDescription
Sets the local description.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelDoSetLocalDescription(PromiseSessionDescription, SessionDescription).)
Protected methodDoSetRemoteDescription
Sets the remote description.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelDoSetRemoteDescription(PromiseSessionDescription, SessionDescription).)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetDynamicValue
Gets a property value from the local cache.
(Inherited from Dynamic.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetStats
Gets the current connection stats.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelGetStats.)
Public methodGetStreamByTypeTStream
Gets the type of the stream by.
Public methodGetStreamsByTypeTStream
Gets the streams by type.
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodProcessDescription
Processes a session description.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Protected methodProcessSdpMediaDescription
Processes a media description.
(Overrides ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannelProcessSdpMediaDescription(TStream, MediaDescription, Int32, Boolean, Boolean).)
Protected methodRaiseGatheringStateChange
Raises gathering state change.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Protected methodRaiseIceConnectionStateChange
Raises ICE connection state change.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Protected methodRaiseLocalCandidate
Raises a local candidate but only if it has not been already raised.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodRemoveIceServer
Removes an ICE server.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodRemoveIceServers
Removes some ICE servers.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodSetDynamicValue
Sets a property value in the local cache.
(Inherited from Dynamic.)
Public methodSetLocalDescription
Sets the local description.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodSetRemoteDescription
Sets the remote description.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public methodToString (Inherited from Object.)
Public methodUnsetDynamicValue
Unsets a property value in the local cache.
(Inherited from Dynamic.)
Top
Events
  NameDescription
Public eventOnGatheringStateChange
Raised when the gathering state changes.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public eventOnIceConnectionStateChange
Raised when the ice connection state changes.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public eventOnLocalCandidate
Raised when a local candidate is added.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public eventOnLocalDescription
Raised when a local description is set.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public eventOnRemoteCandidate
Raised when a remote description is added.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public eventOnRemoteDescription
Raised when a remote description is set.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public eventOnSignallingStateChange
Raised when the signalling state changes.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Public eventOnStateChange
Raised when the connection state changes.
(Inherited from ConnectionBaseTConnection, TStream, TAudioStream, TVideoStream, TDataStream, TDataChannel.)
Top
Fields
See Also