Microsoft.Rtc.Signaling Namespace

  • Article

Classes

  Class Description
Public class AgentIdentity Represents the data to identify a contact.
Public class AuthenticationException Defines the exception to be thrown, when an authentication-related error occurs.
Public class CollectionChangedEventArgs<T> Event information for collection changes.
Public class CollectionExtensions Represents extensions to the Collection class.
Public class ConnectionAuthorizationRequestedEventArgs Represents information needed to authorize a connection.
Public class ConnectionContext Represents information for customizing connections.
Public class ConnectionFailureException Defines the exception to be thrown, when a network connection could not be made. Applications may want to prompt for a new URI (host and port) or a server name.
Public class ConnectionPool Represents a connection pool. Each pool is identified by a destination tuple that consists of the hostname, the listening port of that host, and the transport type (TCP or TLS). The pool consists of 0 or more connections at any time and can grow to a maximum number of connections set by the application. The connection pool only represents outgoing connections and is not used to represent incoming connections as they are not used for pooling.
Public class ContentDescription Represents the base class for all media descriptions.
Public class DiagnosticHeader Represents the diagnostic information received as ms-diagnostic header in the response.
Public class DiagnosticsInformation Represents diagnostics information.
Public class DialogContext Contains information related to a dialog.
Public class EndpointStateChangedEventArgs Indicates changes in EndpointState.
Public class FailureRequestException Defines the exception to be thrown, when a failure message is received as a SIP request message.
Public class FailureResponseException Defines the exception to be thrown, when a failure response is received.
Public class FromToHeader Exposes the parsed value of the "From" and "To" header of a SIP message.
Public class IncomingConnectionAddedEventArgs Contains event information for connections being added.
Public class IncomingConnectionRemovedEventArgs Contains event information for connections being removed.
Public class InvitationAcceptedEventArgs Represents the class used when InvitationAccepted event is raised. This gives access to the headers in the response in addition to informing the appplication that the invitation has been accepted. The headers exposed in this event are the same as the one returned when the application calls the EndEnter methods to fetch headers. If the application registers for this event, it is responsible for sending the acknowledgement in a timely manner. If the application does not send Ack, the platform will send it when the application returns from this event.
Public class MessageParsingException Defines the exception associated with a parsing of header.
Public class MessageReceivedEventArgs Represents the argument for relay events.
Public class NameValuePair This class holds generic name value information.
Public class OfferInInviteResponseEventArgs Used with the HandleOfferInInviteResponse call in IOfferAnswer. This will expose the media offer from the remote participant and gives the ability to send the media answer in the acknowledgement.
Public class OfferInReInviteEventArgs Used with the HandleReInviteOfferReceived call in IOfferAnswer. This will expose the media offer from the remote participant and gives the ability to send the media answer.
Public class OperationFailureException Defines the exception to be thrown, when an operation fails. The FailureReason property indicates the cause of operation failure.
Public class OperationTimeoutException Defines the exception to be thrown, when an operation times out. Generally this is caused when no response is received within a given time.
Public class Participant Contains all the common properties of a participant.
Public class ParticipateStateChangedEventArgs Indicates changes in ParticipateState.
Public class ProvisionalResponseReceivedEventArgs Class contains information for reporting received provisional responses.
Public class PublishSubscribeException Defines the exception associated with a DataSession operation error.
Public class RealTimeAddress Defines the structure identifying a session target.
Public class RealTimeClientConnectionManager Provides services for managing client connections.
Public class RealTimeConnection Represents an outgoing connection used by the endpoints. The connection itself does not know with which endpoint it is associated.
Public class RealTimeConnectionManager Provides connection management, message dispatching, and other miscellaneous services to endpoints.
Public class RealTimeEndpoint Represents an identifiable endpoint from which you can publish or subscribe to data using data sessions or send and receive invitations using signaling sessions. Each such endpoint is uniquely identified by a URI and an endpoint ID, or a GRUU URI.
Public class RealTimeException Represents the base class for all exceptions defined in the UCMA API.
Public class RealTimeInvalidOperationException Thrown when the operation is currently invalid, but the application may be able to take further action based on reason.
Public class RealTimeServerConnectionManager Represents the server-class connection manager that enables listening for incoming connections.
Public class RealTimeServerTcpConnectionManager Provides advanced connection management for using endpoints. This class provides the same functionality as RealTimeConnectionManager and adds the ability to listen for incoming TCP connections.
Public class RealTimeServerTlsConnectionManager Provides advanced connection management for using endpoints. This class provides the same functionality as RealTimeConnectionManager and adds the ability to listen for incoming TLS connections.
Public class RedirectingEventArgs Exposes the redirect target URI and lets the application try the URI depending upon the State property.
Public class ReferNotifier Lets the application set the various Refer states indicating progress. This is used by the application that is receiving the Refer request.
Public class ReferReceivedEventArgs Represents the argument for the Refer state changed event.
Public class ReferStateChangedEventArgs Represents the event argument for Refer state changed event.
Public class ReferStatus Represents the state of the Refer operation. This object is created by the application sending the Refer message to track the status of the Refer as carried out by the remote endpoint. The notifications sent by the remote endpoint are reflected in this instance.
Public class RegisterException Defines the exception to be thrown, when an error occurs in the register operation.
Public class RegistrationStateChangedEventArgs Defines state change EventArgs for Registration state changes.
Public class RequestOrResponseReceivedEventArgs Represents a request or response received.
Public class ResponseCode Represents possible well-known response codes that can be used when sending responses.
Public class RouteSetRecoverySettings Represents the settings for driving route set recovery behavior.
Public class RouteSetStatusChangedEventArgs Represents event args for conveying the route status.
Public class Sdp<TGlobalDescription, TMediaDescription> Parses or builds an SDP as defined by RFC 2327. Note: All public static members of this type are thread-safe. All instance members are not guaranteed to be thread-safe.
Public class SdpAttribute Represents the "a" line from the SDP.
Public class SdpBandwidth Represents the "b" line from the SDP.
Public class SdpConnection Contains either an IP address or a hostname found in the SDP.
Public class SdpDescription Applies an alias for the generic class for simplicity.
Public class SdpEncryptionKey Represents a "k" line from the SDP.
Public class SdpGlobalDescription Contains components of the global section of the SDP.
Public class SdpMediaDescription Represents a media section of the SDP.
Public class SdpOrigin Represents the "o" line in the SDP.
Public class SdpParseStatus Stores state and provides utility routines on state that is common to the various parsing routines.
Public class SdpWriter Represents a class that is passed to functions that will serialize the SDP attribute.
Public class SendMessageOptions Represents options for customizing message send behavior.
Public class SendProvisionalResponseOptions Represents the options for sending a provisional response.
Public class ServerPolicyException Defines the exception to be thrown, when an operation is rejected due to server policy.
Public class SessionReceivedEventArgs Represents the argument for the incoming session event.
Public class SignalingContentDescription Obsolete. This class is obsolete in UCMA 3.0 and will be removed from later versions. As an alternative, applications can use the ContentDescription class.Describes a content description and additional negotiation information.
Public class SignalingHeader Represents the signaling header that can be added by the applications. Signaling headers allow applications to supply SIP headers as name-value pairs. These headers are exposed for incoming messages and used for attaching headers in outgoing messages.
Public class SignalingHeaderParser Assists in parsing a SignalingHeader object to decompose a header into parts such as displayname, URI, and parameters. If any component does not exist in the given header, it will be null.
Public class SignalingParticipant Represents a participant in a session.
Public class SignalingPropertyChangedEventArgs Returns information indicating which properties have changed.
Public class SignalingSession This class represents an Invite based two party session. The session is normally used for offer answer negotiation and signaling call control.
Public class SignalingSessionAcceptOptions Represents the options when establishing a session.
Public class SignalingSessionEstablishOptions Represents the options when establishing a session.
Public class SignalingSessionSettings Represents the configuration settings for a SignalingSession.
Public class SignalingStateChangedEventArgs Indicates changes in SignalingState.
Public class SipCredentialCache Provides storage for multiple name-password pairs and associates these with the realm.
Public class SipDialogContext Contains information related to a dialog.
Public class SipEndpoint Represents a registration server based endpoint. All messages are routed to this server. The endpoint caches the connection created to communicate with the server.
Public class SipMessageData Captures information in a SIP message (request or response). It gives access to information that is common to request or response.
Public class SipPeerToPeerEndpoint Represents an endpoint with no registration server.
Public class SipRequestData Captures information in an incoming SIP request. It gives access to the message type in addition to what is exposed in a SipMessageData class. This class is used only to expose an incoming request and cannot be used to create an outgoing request.
Public class SipRequestReceivedEventArgs Represents the class used when the event is raised for received SIP request.
Public class SipResponseData Captures information in a SIP response. It gives access to the response code and response text in addition to what is exposed in SipMessageData.
Public class SipResponseReceivedEventArgs Represents the class used when the event is raised with response data.
Public class SipServiceRequest This class is no longer being maintained. Instead of using the methods on this class, developers are advised to use the BeginSendMessage and EndSendMessage methods on the RealTimeEndpoint class. Sends a service request to the server. It allows a user to add the message body and content type on a service request. Also provides an overload to send a custom "To" Header and accepted Headers.
Public class SipSubscription Provides low-level subscription and notification. Users of this class need to pass the ISubscriptionProcessor interface to interact with the subscription. It automatically refreshes the subscription, 15 minutes before the expiry. Users of SipSubscription can also refresh the subscription themselves.
Public class SipUriParameter Represents a general URI parameter.
Public class SipUriParser Provides means to parse a sip URI.
Public class StateChangedEventArgs<T> Represents a Generic class for reporting state changed event. This class provides the old and new state.
Public class SubscriptionStateChangedEventArgs Returns information relevant to a subscription state change.
Public class TimerItem Defines a timer item to set up a timer. When the timer expires, a supplied callback is called. The timer item needs access to a TimerWheel in which the timer item is managed.
Public class TimerWheel Provides support for managing a large number of timers represented by TimerItem instances. The timer wheel is optimized so that add/remove operations for timer items is constant time (O(1)).
Public class TlsFailureException Defines the exception to be thrown, when there is a connection issue due to the use of TLS.
Public class UnhandledExceptionManager Provides a way for the application to register for a handler to catch any unhandled exceptions uncaught from a worker thread initiated by the platform.
Public class WarningCode Represents possible well-known warning codes that can be used when sending responses.
Public class WarningHeader Represents the diagnostic information received as Warning header. Warning is a general SIP header, which conveys the warnings from the remote.

Interfaces

  Interface Description
Public interface IOfferAnswer Defines the contract to be implemented by the caller of a signaling session for media offer/answer negotiation.
Public interface ISipSubscriptionProcessor Represents the interface that needs to be implemented by users of the SipSubscription class. The reference to this interface needs to be passed to the SipSubscription class instantiation.

Delegates

  Delegate Description
Public delegate UnhandledThreadPoolExceptionHandler Unhandled Threadpool Exception event handler would be raised whenever an unhandled exception occurs in a threadpool used by the platform. If this delegate returns true then the exception is ignored, otherwise it is rethrown.

Enumerations

  Enumeration Description
Public enumeration AuthenticationFailureReason Indicates possible reason for authentication-related failures.
Public enumeration ConnectionAuthorizationAction Indicates the purpose for the event.
Public enumeration DiagnosticVisibility Visibility of the diagnostic headers.
Public enumeration EndpointState Enumerates possible states for an endpoint.
Public enumeration EndpointTransitionReason Indicates possible reasons for state transitions.
Public enumeration ExtensionFeatureSupport Possible values for an extension feature as supported by the local or remote participant.
Public enumeration InvalidOperationReason Gives detailed reasons for the exception.
Public enumeration MessageType Indicates the message types possible with the SendMessage API in session or endpoint.
Public enumeration OperationFailureReason Indicates the reason for the failure of an operation.
Public enumeration ParsingFailureReason Indicates reasons for parsing to fail.
Public enumeration ParticipantPropertyChanges Indicates which participant properties have changed.
Public enumeration ParticipateState Indicates what methods have been called on the object (Activity/CollaborationSession). The ParticipateState records which methods have been called when the object is in the Idle or Incoming SignalingState. It can be used to determine if a Participate or Terminate is being processed before the state change happens.
Public enumeration RedirectAction Indicates possible actions for a redirect target.
Public enumeration ReferState Indicates possible states for the signaling session.
Public enumeration RegistrationState Indicates the registration state.
Public enumeration RegistrationTransitionReason Indicates possible reasons for state transitions.
Public enumeration RouteSetRecoveryMode Represents the modes of recovery of a session whose route set has been invalidated.
Public enumeration RouteSetStatus The status of the dialog route set.
Public enumeration SdpEncryptionMethod Indicates possible values for the SDP encryption method found in the "k" line of an SDP.
Public enumeration ServiceState Represents the state of a service.
Public enumeration SignalingState Indicates possible states for the signaling session.
Public enumeration SignalingTransitionReason Indicates possible reasons for state transitions.
Public enumeration SipAuthenticationProtocols Indicates possible authentication protocols. Applications can define additional values and cast them to AuthenticationProtocol.
Public enumeration SipSubscription.RequestType Indicates possible request types. Will be passed to derived classes to add extended headers or message body.
Public enumeration SipTransportType Indicates the possible transport types.
Public enumeration SubscriptionSignalingState Indicates the current state of the subscription object.
Public enumeration TlsFailureReason Indicates possible reasons for TLS failure. Only common failures are given specific values.
Public enumeration TransitionReason Indicates whether the subscription state transition is caused by the server or the client.