Class SIPNotifierClient

This class represent a client for a SIP notifier server. The client can subscribe to notifications from the server as outlined in RFC3265. The generic parameter is used to set the type of notification the client will generate. Different SIP event packages have different ways of representing their data. For example RFC4235 uses XML to convey dialog notifications, RFC3842 uses plain text to convey message waiting indications.

Inheritance
System.Object
SIPNotifierClient
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SIPSorcery.SIP.App
Assembly: SIPSorcery.dll
Syntax
public class SIPNotifierClient

Constructors

| Improve this Doc View Source

SIPNotifierClient(SIPTransport, SIPEndPoint, SIPEventPackagesEnum, SIPURI, String, String, String, Int32, String)

Declaration
public SIPNotifierClient(SIPTransport sipTransport, SIPEndPoint outboundProxy, SIPEventPackagesEnum sipEventPackage, SIPURI resourceURI, string authUsername, string authDomain, string authPassword, int expiry, string filter)
Parameters
Type Name Description
SIPTransport sipTransport
SIPEndPoint outboundProxy
SIPEventPackagesEnum sipEventPackage
SIPURI resourceURI
System.String authUsername
System.String authDomain
System.String authPassword
System.Int32 expiry
System.String filter

Properties

| Improve this Doc View Source

CallID

Declaration
public string CallID { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

LastSubscribeAttempt

Declaration
public DateTime LastSubscribeAttempt { get; }
Property Value
Type Description
System.DateTime

Methods

| Improve this Doc View Source

Resubscribe()

If the client is waiting for the timeout until the next subscribe is due calling this method will result in an immediate attempt to re-subscribe. When a subscribe request is received the notification server should send a full state notification so this method is useful to refresh client state.

Declaration
public void Resubscribe()
| Improve this Doc View Source

Start()

Declaration
public void Start()
| Improve this Doc View Source

Stop()

Declaration
public void Stop()
| Improve this Doc View Source

Subscribe(SIPURI, Int64, SIPEventPackagesEnum, String, SIPURI)

Initiates a SUBSCRIBE request to a notification server.

Declaration
public void Subscribe(SIPURI subscribeURI, long expiry, SIPEventPackagesEnum sipEventPackage, string subscribeCallID, SIPURI contactURI)
Parameters
Type Name Description
SIPURI subscribeURI

The SIP user that dialog notifications are being subscribed to.
System.Int64 expiry
SIPEventPackagesEnum sipEventPackage
System.String subscribeCallID
SIPURI contactURI

Events

| Improve this Doc View Source

NotificationReceived

Declaration
public event Action<SIPEventPackagesEnum, string> NotificationReceived
Event Type
Type Description
System.Action<SIPEventPackagesEnum, System.String>
| Improve this Doc View Source

SubscriptionFailed

Declaration
public event Action<SIPURI, SIPResponseStatusCodesEnum, string> SubscriptionFailed
Event Type
Type Description
System.Action<SIPURI, SIPResponseStatusCodesEnum, System.String>
| Improve this Doc View Source

SubscriptionSuccessful

Declaration
public event Action<SIPURI> SubscriptionSuccessful
Event Type
Type Description
System.Action<SIPURI>

Extension Methods