sip.js.md

Home > sip.js

sip.js package

A core library implementing low level SIP protocol elements.

Classes

Class	Description
ByeUserAgentClient	BYE UAC.
ByeUserAgentServer	BYE UAS.
CancelUserAgentClient	CANCEL UAC.
ClientTransaction	Client Transaction.
Dialog	Dialog.
Exception	An Exception is considered a condition that a reasonable application may wish to catch. An Error indicates serious problems that a reasonable application should not try to catch.
IncomingMessage	Incoming message.
IncomingRequestMessage	Incoming request message.
IncomingResponseMessage	Incoming response message.
InfoUserAgentClient	INFO UAC.
InfoUserAgentServer	INFO UAS.
InviteClientTransaction	INVITE Client Transaction.
InviteServerTransaction	INVITE Server Transaction.
InviteUserAgentClient	INVITE UAC.
InviteUserAgentServer	INVITE UAS.
Logger	Logger.
LoggerFactory	Logger.
MessageUserAgentClient	MESSAGE UAC.
MessageUserAgentServer	MESSAGE UAS.
NameAddrHeader	Name Address SIP header.
NonInviteClientTransaction	Non-INVITE Client Transaction.
NonInviteServerTransaction	Non-INVITE Server Transaction.
NotifyUserAgentClient	NOTIFY UAS.
NotifyUserAgentServer	NOTIFY UAS.
OutgoingRequestMessage	Outgoing SIP request message.
PrackUserAgentClient	PRACK UAC.
PrackUserAgentServer	PRACK UAS.
PublishUserAgentClient	PUBLISH UAC.
ReferUserAgentClient	REFER UAC.
ReferUserAgentServer	REFER UAS.
RegisterUserAgentClient	REGISTER UAC.
RegisterUserAgentServer	REGISTER UAS.
ReInviteUserAgentClient	Re-INVITE UAC.
ReInviteUserAgentServer	Re-INVITE UAS.
ReSubscribeUserAgentClient	Re-SUBSCRIBE UAC.
ReSubscribeUserAgentServer	Re-SUBSCRIBE UAS.
ServerTransaction	Server Transaction.
SessionDialog	Session Dialog.
SubscribeUserAgentClient	SUBSCRIBE UAC.
SubscribeUserAgentServer	SUBSCRIBE UAS.
SubscriptionDialog	Subscription Dialog.
Transaction	Transaction.
TransactionStateError	Indicates that the operation could not be completed given the current transaction state.
TransportError	Transport error.
URI	URI.
UserAgentClient	User Agent Client (UAC).
UserAgentCore	User Agent Core.
UserAgentServer	User Agent Server (UAS).

Enumerations

Enumeration	Description
Levels	Log levels.
SessionState	Session state.
SignalingState	Offer/Answer state.
SubscriptionState	Subscription state.
TransactionState	Transaction state.

Interfaces

Interface	Description
AckableIncomingResponseWithSession	Incoming INVITE response received when request is accepted.
Body	Message body.
ClientTransactionUser	UAC Core Transaction User.
Contact	Contact.
DialogState	Dialog state.
IncomingAckRequest	Incoming ACK request.
IncomingByeRequest	Incoming BYE request.
IncomingByeResponse	Incoming BYE response.
IncomingCancelRequest	Incoming CANCEL request.
IncomingCancelResponse	Incoming CANCEL response.
IncomingInfoRequest	Incoming INFO request.
IncomingInfoResponse	Incoming INFO response.
IncomingInviteRequest	Incoming INVITE request.
IncomingMessageRequest	Incoming MESSAGE request.
IncomingMessageResponse	Incoming MESSAGE response.
IncomingNotifyRequest	Incoming NOTIFY request.
IncomingNotifyResponse	Incoming NOTIFY response.
IncomingPrackRequest	Incoming PRACK request.
IncomingPrackResponse	Incoming PRACK response.
IncomingPublishRequest	Incoming PUBLISH request.
IncomingPublishResponse	Incoming PUBLISH response.
IncomingReferRequest	Incoming REFER request.
IncomingReferResponse	Incoming REFER response.
IncomingRegisterRequest	Incoming REGISTER request.
IncomingRegisterResponse	Incoming REGISTER response.
IncomingRequest	A SIP message sent from a remote client to a local server.
IncomingRequestDelegate	Delegate providing custom handling of incoming requests.
IncomingRequestWithSubscription	Incoming NOTIFY request with associated Subscription.
IncomingResponse	A SIP message sent from a remote server to a local client.
IncomingSubscribeRequest	Incoming SUBSCRIBE request.
IncomingSubscribeResponse	Incoming SUBSCRIBE response.
OutgoingAckRequest	Outgoing ACK request.
OutgoingByeRequest	Outgoing BYE request.
OutgoingCancelRequest	Outgoing CANCEL request.
OutgoingInfoRequest	Outgoing INFO request.
OutgoingInviteRequest	Outgoing INVITE request.
OutgoingInviteRequestDelegate	Delegate providing custom handling of outgoing INVITE requests.
OutgoingMessageRequest	Outgoing MESSAGE request.
OutgoingNotifyRequest	Outgoing NOTIFY request.
OutgoingPrackRequest	Outgoing PRACK request.
OutgoingPublishRequest	Outgoing PUBLISH request.
OutgoingReferRequest	Outgoing REFER request.
OutgoingRegisterRequest	Outgoing REGISTER request.
OutgoingRequest	A SIP message sent from a local client to a remote server.
OutgoingRequestDelegate	Delegate providing custom handling of outgoing requests.
OutgoingRequestMessageOptions	Outgoing request message options.
OutgoingResponse	A SIP message sent from a local server to a remote client.
OutgoingResponseWithSession	Outgoing INVITE response with the associated Session.
OutgoingSubscribeRequest	Outgoing SUBSCRIBE request.
OutgoingSubscribeRequestDelegate	Delegate providing custom handling of outgoing SUBSCRIBE requests.
PrackableIncomingResponseWithSession	Incoming INVITE response received when request is progressed.
RequestOptions	Request options bucket.
ResponseOptions	Response options bucket.
ServerTransactionUser	UAS Core Transaction User.
Session	Session.
SessionDelegate	Session delegate.
Subscription	Subscription.
SubscriptionDelegate	Subscription delegate.
TransactionUser	Transaction User (TU).
Transport	Transport layer interface expected by the user agent core.
UserAgentCoreConfiguration	User Agent Core configuration.
UserAgentCoreDelegate	User Agent Core delegate.

Variables

Variable	Description
Timers	Timers.