SignalingSession Members

  • Article

Represents an INVITE-based two-party session.

The SignalingSession type exposes the following members.

Constructors

  Name Description
Public method SignalingSession(RealTimeEndpoint, RealTimeAddress) Creates a new instance of the class.
Public method SignalingSession(RealTimeEndpoint, RealTimeAddress, String) Creates a new instance of the class.
Public method SignalingSession(RealTimeEndpoint, String, String, RealTimeAddress) Creates a new instance of the class.
Public method SignalingSession(RealTimeEndpoint, String, String, RealTimeAddress, String) Creates a new instance of the class.

Top

Properties

  Name Description
Public property CallId Gets the session ID.
Public property Connection Gets the connection used by this signaling session.
Public property DesiredSessionTimerInterval Gets and sets the desired session timer interval for the application, in seconds.
Public property Endpoint Gets the endpoint associated with the session.
Public property FromTag Gets the tag used in the "From" header.
Public property Grid Gets or sets the grid context for this session.
Public property IsIncoming
Public property IsSessionTimerSupported Gets or sets whether the session supports a session timer.
Public property LocalParticipant Gets the local participant of the session.
Public property MinimumSessionExpiresInterval Gets and sets the minimum session expires interval value, in seconds, of the session.
Public property OfferAnswerNegotiation Gets and sets the media negotiation callback interface implemented by the caller.
Public property ReliableProvisionalResponsePolicy Gets or sets the default policy for supporting 100rel extension feature.
Public property RemoteParticipant Gets the remote participant of the session.
Public property SessionTarget Gets the target of the session.
Public property SessionTimerInterval Gets the session timer interval, in seconds.
Public property State Gets the state of the session.
Public property ToTag Gets the tag used in the "To" header.

Top

Methods

  Name Description
Public method BeginAccept(AsyncCallback, Object)
Public method BeginAccept(SignalingSessionAcceptOptions, AsyncCallback, Object)
Public method BeginEstablish(AsyncCallback, Object)
Public method BeginEstablish(SignalingSessionEstablishOptions, AsyncCallback, Object)
Public method BeginParticipate(AsyncCallback, Object) Participates in a session.
Public method BeginParticipate(IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object) Participates in a session.
Public method BeginRefer(RealTimeAddress, ReferStatus, AsyncCallback, Object) Refers an URI to the remote participant.
Public method BeginRefer(RealTimeAddress, ReferStatus, IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object) Refers an URI to the remote participant.
Public method BeginRefer(RealTimeAddress, ReferStatus, IEnumerable<(Of <<'(SignalingHeader>)>>), ContentType, array<Byte>[]()[][], AsyncCallback, Object)
Public method BeginRenegotiateDescription(AsyncCallback, Object) Renegotiates the media description.
Public method BeginRenegotiateDescription(IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object) Renegotiates the media description.
Public method BeginRenegotiateDescription(SipDialogContext, IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object)
Public method BeginSendMessage(MessageType, ContentType, array<Byte>[]()[][], AsyncCallback, Object) Sends a message.
Public method BeginSendMessage(MessageType, ContentType, array<Byte>[]()[][], IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object) Sends a message to the specified participant.
Public method BeginSendReliableProvisionalResponse(Int32, IEnumerable<(Of <<'(SignalingHeader>)>>), Boolean, AsyncCallback, Object) Sends a reliable provisional response with option to send answer for early media.
Public method BeginSendReliableProvisionalResponse(Int32, String, IEnumerable<(Of <<'(SignalingHeader>)>>), Boolean, AsyncCallback, Object)
Public method BeginSetConnection Sets the connection for the outgoing signaling session before calling [Participate].
Public method BeginTerminate(AsyncCallback, Object) Terminates the session asynchronously.
Public method BeginTerminate(IEnumerable<(Of <<'(SignalingHeader>)>>), AsyncCallback, Object) Terminates the session asynchronously.
Public method EndAccept
Public method EndEstablish
Public method EndParticipate Waits for the pending [Participate] operation to complete.
Public method EndRefer Waits for the pending [Refer] operation to complete.
Public method EndRenegotiateDescription Waits for the pending [Renegotiate] operation to complete.
Public method EndSendMessage Waits for the pending [SendMessage] operation to complete.
Public method EndSendReliableProvisionalResponse Waits for the pending SendProvisionalResponse operation to complete.
Public method EndSetConnection Waits for the pending [SetConnection] operation to complete.
Public method EndTerminate Waits for the pending [Terminate] operation to complete.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Participate()()()() Performs a synchronous [Participate] operation.
Public method Participate(IEnumerable<(Of <<'(SignalingHeader>)>>)) Performs a synchronous [Participate] operation.
Public method Refer(RealTimeAddress, ReferStatus) Performs a synchronous transfer of the current session.
Public method Refer(RealTimeAddress, ReferStatus, IEnumerable<(Of <<'(SignalingHeader>)>>)) Performs a synchronous transfer of the current session.
Public method RenegotiateDescription()()()() Renegotiates the media description synchronously.
Public method RenegotiateDescription(IEnumerable<(Of <<'(SignalingHeader>)>>)) Synchronously renegotiates the media description.
Public method SendMessage(MessageType, ContentType, array<Byte>[]()[][]) Sends a message synchronously.
Public method SendMessage(MessageType, ContentType, array<Byte>[]()[][], IEnumerable<(Of <<'(SignalingHeader>)>>)) Sends a message synchronously.
Public method SendProvisionalResponse(Int32, IEnumerable<(Of <<'(SignalingHeader>)>>)) Sends a provisional response synchronously.
Public method SendProvisionalResponse(Int32, IEnumerable<(Of <<'(SignalingHeader>)>>), Boolean) Sends a provisional response synchronously.
Public method SendProvisionalResponse(Int32, String, IEnumerable<(Of <<'(SignalingHeader>)>>), Boolean)
Public method SetConnection Sets the connection to use for the outgoing signaling session before calling [Participate].
Public method Terminate()()()() This method terminates the session synchronously.
Public method Terminate(IEnumerable<(Of <<'(SignalingHeader>)>>)) Terminates the session synchronously.
Public method TerminateWithRedirection(RealTimeAddress) Terminates an incoming session by redirecting the inviter with an address.
Public method TerminateWithRedirection(IEnumerable<(Of <<'(RealTimeAddress>)>>)) Terminates an incoming session by redirecting the inviter with a list of addresses.
Public method TerminateWithRedirection(Int32, IEnumerable<(Of <<'(RealTimeAddress>)>>))
Public method TerminateWithRejection Terminates a session by rejecting the incoming INVITE.
Public method ToString (Inherited from Object.)
Public method TryCancelRenegotiateDescription()()()() Attempts to cancel a pending renegotiation.
Public method TryCancelRenegotiateDescription(IEnumerable<(Of <<'(SignalingHeader>)>>)) Attempts to cancel a pending renegotiation.

Top

Events

  Name Description
Public event InvitationAccepted Raised when the remote has accepted the INVITE.
Public event InvitationCompleted Raised when the INVITE process completes.
Public event MessageReceived Raised when a message is received.
Public event ProvisionalResponseReceived Raised when the session received a provisional response (101-199).
Public event Redirecting Raised when a redirect request is received.
Public event ReferReceived Raised when a new Refer is received.
Public event ReInviteReceived Raised when the remote sends a re-invite.
Public event RenegotiationToRefreshNeeded Raised when renegotiation is needed to refresh the session.
Public event RequestOrResponseReceived
Public event StateChanged Raised when the state of the session changes.
Public event TerminatedByRemote Raised when the remote side terminates the session by sending a goodbye message.

Top

See Also

Reference

SignalingSession Class

Microsoft.Rtc.Signaling Namespace