This documentation is archived and is not being maintained.

PublishSubscribeSession Members

PublishSubscribeSession class provides a simplified wrapped implementation of ISipSubscriptionProcessor to establish, terminate subscription, processing the SipSubscription event.

The PublishSubscribeSession type exposes the following members.

  NameDescription
Public propertyIsSubscriptionActiveReturns true if session has an active underlying subscription, else returns false.
Public propertySubscriberEndpointEndpoint of the subscriber, to be used in From address for subscription and publishing.
Protected propertySubscriptionReturns the instance of the underlying subscription object.
Top

  NameDescription
Protected methodBeginPublishServiceRequest(String, ContentType, String, AsyncCallback, Object)This method will create a SipService Request for the given contentType and messageBody, service operation started with this method should be completed via calling the EndPublishServiceRequest method.
Protected methodBeginPublishServiceRequest(String, ContentType, IEnumerable<(Of <<'(SignalingHeader>)>>), String, AsyncCallback, Object)This method will create a SipService Request for the given contentType, messageBody and additional custom headers.
Public methodBeginRefresh
Public methodBeginSubscribeCreate the SipSubscriptionProcessor and invoke BeginSubscribe on the subscription.
Public methodBeginUnsubscribeInvoke BeginTerminate on the subscription, if no underlying subscription exists, then completed as no operation.
Protected methodEndPublishServiceRequestEnd the publish service request operation, which was initiated with StartPublishServiceRequest call.
Public methodEndRefreshComplete the Refresh Operation initiated by BeginRefresh.
Public methodEndSubscribeComplete the Subscribe operation initiated by BeginSubscribe.
Public methodEndUnsubscribeEnd the async operation started by BeginUnSubscribe method call.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetEventPackageNameAll derived implementation classes should implement this method, the event package will be used for the subscription for this PublishSubscribeSession.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodRaiseEventViaEndpointQueue<(Of <<'(T>)>>)
Protected methodThrowIfEndpointAndSessionStateNotValid
Protected methodThrowIfEndpointNotEstablished[Value Needed].
Protected methodThrowIfSessionStateNotValid[Value Needed].
Public methodToString (Inherited from Object.)
Protected methodUnbindDispose of the processor so that subscribe may be called again.
Top

  NameDescription
Public eventSignalingSubscriptionStateChangeSubscriptionStateChange event handler notes the change in underlying subscription states.
Top
Show: