Classes
Class | Description | |
---|---|---|
AuthenticationException |
Defines the exception to be thrown, when an
authentication-related error occurs.
|
|
CollectionChangedEventArgs < (Of < ( T > ) > ) |
Event information for collection
changes.
|
|
ConnectionAuthorizationRequestedEventArgs |
Represents information needed to authorize a
connection.
|
|
ConnectionContext |
Represents information needed to configure an
outgoing connection.
|
|
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.
|
|
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.
|
|
ContentDescription |
Represents the base class for all media
descriptions.
|
|
DiagnosticHeader |
Represents the diagnostic information received
as ms-diagnostic header in the response.
|
|
DialogContext |
Contains information related to a
dialog.
|
|
EndpointStateChangedEventArgs |
Indicates changes in EndpointState.
|
|
FailureResponseException |
Defines the exception to be thrown, when a
failure response is received.
|
|
FromToHeader |
Exposes the parsed value of the "From" and
"To" header of a SIP message.
|
|
IncomingConnectionAddedEventArgs |
Contains event information for connections
being added.
|
|
IncomingConnectionRemovedEventArgs |
Contains event information for connections
being removed.
|
|
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.
|
|
MessageParsingException |
Defines the exception associated with a
parsing of header.
|
|
MessageReceivedEventArgs |
Represents the argument for relay
events.
|
|
NameValuePair |
This class holds generic name value
information.
|
|
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
acknowledgment.
|
|
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.
|
|
OperationFailureException |
Defines the exception to be thrown, when an
operation fails. The FailureReason property indicates the cause of
operation failure.
|
|
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.
|
|
Participant |
Contains all the common properties of a
participant.
|
|
ParticipateStateChangedEventArgs |
Indicates changes in ParticipateState.
|
|
ProvisionalResponseReceivedEventArgs |
Class contains information for reporting
received provisional responses.
|
|
PublishSubscribeException |
Defines the exception associated with a
DataSession operation error.
|
|
RealTimeAddress |
Defines the structure identifying a session
target.
|
|
RealTimeClientConnectionManager |
Provides services for managing client
connections.
|
|
RealTimeConnection |
Represents an outgoing connection used by the
endpoints. The connection itself does not know with which endpoint
it is associated.
|
|
RealTimeConnectionManager |
Provides connection management, message
dispatching, and other miscellaneous services to endpoints.
|
|
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.
|
|
RealTimeException |
Represents the base class for all exceptions
defined in the UCMA API.
|
|
RealTimeInvalidOperationException |
Thrown when the operation is currently
invalid, but the application may be able to take further action
based on reason.
|
|
RealTimeServerConnectionManager |
Represents the server-class connection manager
that enables listening for incoming connections.
|
|
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.
|
|
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.
|
|
RedirectingEventArgs |
Exposes the redirect target URI and lets the
application try the URI depending upon the State property.
|
|
ReferNotifier |
Lets the application set the various Refer
states indicating progress. This is used by the application that is
receiving the Refer request.
|
|
ReferReceivedEventArgs |
Represents the argument for the Refer state
changed event.
|
|
ReferStateChangedEventArgs |
Represents the event argument for Refer state
changed event.
|
|
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.
|
|
RegisterException |
Defines the exception to be thrown, when an
error occurs in the register operation.
|
|
RegistrationStateChangedEventArgs |
Defines state change EventArgs for
Registration state changes.
|
|
RequestOrResponseReceivedEventArgs |
Represents a request or response received in a
signaling session.
|
|
ResponseCode |
Represents possible well-known response codes
that can be used when sending responses.
|
|
Sdp < (Of < ( 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.
|
|
SdpAttribute |
Represents the "a" line from the SDP.
|
|
SdpBandwidth |
Represents the "b" line from the SDP.
|
|
SdpConnection |
Contains either an IP address or a hostname
found in the SDP.
|
|
SdpDescription |
Applies an alias for the generic class for
simplicity.
|
|
SdpEncryptionKey |
Represents a "k" line from the SDP.
|
|
SdpGlobalDescription |
Contains components of the global section of
the SDP.
|
|
SdpMediaDescription |
Represents a media section of the SDP.
|
|
SdpOrigin |
Represents the "o" line in the SDP.
|
|
SdpParseStatus |
Stores state and provides utility routines on
state that is common to the various parsing routines.
|
|
SdpWriter |
Represents a class that is passed to functions
that will serialize the SDP attribute.
|
|
SendMessageOptions |
Represents options that can be configured by
an application for sending a message.
|
|
ServerPolicyException |
Defines the exception to be thrown, when an
operation is rejected due to server policy.
|
|
SessionReceivedEventArgs |
Represents the argument for the incoming
session event.
|
|
SignalingContentDescription |
Describes a content description and additional
negotiation information.
|
|
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.
|
|
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.
|
|
SignalingParticipant |
Represents a participant in a session.
|
|
SignalingPropertyChangedEventArgs |
Returns information indicating which
properties have changed.
|
|
SignalingSession |
This class represents an Invite based two
party session. The session is normally used for media negotiation
and signaling call control.
|
|
SignalingSessionAcceptOptions |
Represents the options when accepting a
session.
|
|
SignalingSessionEstablishOptions |
Represents the options when establishing a
session.
|
|
SignalingStateChangedEventArgs |
Indicates changes in SignalingState.
|
|
SipCredentialCache |
Provides storage for multiple name-password
pairs and associates these with the realm.
|
|
SipDialogContext |
Contains information related to a
dialog.
|
|
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.
|
|
SipMessageData |
Captures information in a SIP message (request
or response). It gives access to information that is common to
request or response.
|
|
SipPeerToPeerEndpoint |
Represents an endpoint with no registration
server.
|
|
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.
|
|
SipRequestReceivedEventArgs |
Represents the class used when the event is
raised for received SIP request.
|
|
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.
|
|
SipResponseReceivedEventArgs |
Represents the class used when the event is
raised with response data.
|
|
SipServiceRequest |
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.
|
|
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.
|
|
SipUriParameter |
Represents a general URI parameer.
|
|
SipUriParser |
Provides means to parse a sip URI.
|
|
StateChangedEventArgs < (Of < ( T > ) > ) |
Represents a Generic class for reporting state
changed event. This class provides the old and new state.
|
|
SubscriptionStateChangedEventArgs |
Returns information relevant to a subscription
state change.
|
|
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.
|
|
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)).
|
|
TlsFailureException |
Defines the exception to be thrown, when there
is a connection issue due to the use of TLS.
|
|
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.
|
|
WarningCode |
Represents possible well-known warning codes
that can be used when sending responses.
|
Interfaces
Interface | Description | |
---|---|---|
IOfferAnswer |
Defines the contract to be implemented by the
caller of a signaling session for media offer/answer
negotiation.
|
|
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 | |
---|---|---|
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 | |
---|---|---|
AuthenticationFailureReason |
Indicates possible reason for
authentication-related failures.
|
|
ConnectionAuthorizationAction |
Represents possible actions to be taken by the
application when authorizing connections.
|
|
EndpointState |
Enumerates possible states for an
endpoint.
|
|
EndpointTransitionReason |
Indicates possible reasons for state
transitions.
|
|
ExtensionFeatureSupport |
Possible values for an extension feature as
supported by the local or remote participant.
|
|
InvalidOperationReason |
Gives detailed reasons for the
exception.
|
|
MessageType |
Indicates the message types possible with the
SendMessage API in session or endpoint.
|
|
OperationFailureReason |
Indicates the reason for the failure of an
operation.
|
|
ParsingFailureReason |
Indicates reasons for parsing to fail.
|
|
ParticipantPropertyChanges |
Indicates which participant properties have
changed.
|
|
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.
|
|
RedirectAction |
Indicates possible actions for a redirect
target.
|
|
ReferState |
Indicates possible states for the signaling
session.
|
|
RegistrationState |
Indicates the registration state.
|
|
RegistrationTransitionReason |
Indicates possible reasons for state
transitions.
|
|
RouteSetRestorationStatus |
The status of route restoration
|
|
SdpEncryptionMethod |
Indicates possible values for the SDP
encryption method found in the "k" line of an SDP.
|
|
SignalingState |
Indicates possible states for the signaling
session.
|
|
SignalingTransitionReason |
Indicates possible reasons for state
transitions.
|
|
SipAuthenticationProtocols |
Indicates possible authentication protocols.
Applications can define additional values and cast them to
AuthenticationProtocol.
|
|
SipSubscription . . :: . RequestType |
Indicates possible request types. Will be
passed to derived classes to add extended headers or message
body.
|
|
SipTransportType |
Indicates the possible transport types.
|
|
SubscriptionSignalingState |
Indicates the current state of the
subscription object.
|
|
TlsFailureReason |
Indicates possible reasons for TLS failure.
Only common failures are given specific values.
|
|
TransitionReason |
Indicates whether the subscription state
transition is caused by the server or the client.
|