Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 4.41 KB

sip.js.useragentcore.md

File metadata and controls

58 lines (42 loc) · 4.41 KB

Home > sip.js > UserAgentCore

UserAgentCore class

User Agent Core.

Signature:

export declare class UserAgentCore

Remarks

Core designates the functions specific to a particular type of SIP entity, i.e., specific to either a stateful or stateless proxy, a user agent or registrar. All cores, except those for the stateless proxy, are transaction users. https://tools.ietf.org/html/rfc3261\#section-6

UAC Core: The set of processing functions required of a UAC that reside above the transaction and transport layers. https://tools.ietf.org/html/rfc3261\#section-6

UAS Core: The set of processing functions required at a UAS that resides above the transaction and transport layers. https://tools.ietf.org/html/rfc3261\#section-6

Constructors

Constructor Modifiers Description
(constructor)(configuration, delegate) Constructor.

Properties

Property Modifiers Type Description
configuration UserAgentCoreConfiguration Configuration.
delegate UserAgentCoreDelegate Delegate.
dialogs Map<string, Dialog> Dialogs.
loggerFactory LoggerFactory Logger factory.
subscribers Map<string, SubscribeUserAgentClient> Subscribers.
transport Transport Transport.
userAgentClients Map<string, UserAgentClient> UACs.
userAgentServers Map<string, UserAgentServer> UASs.

Methods

Method Modifiers Description
dispose() Destructor.
invite(request, delegate) Send INVITE.
makeOutgoingRequestMessage(method, requestURI, fromURI, toURI, options, extraHeaders, body) Outgoing request message factory function.
message(request, delegate) Send MESSAGE.
publish(request, delegate) Send PUBLISH.
receiveIncomingRequestFromTransport(message) Handle an incoming request message from the transport.
receiveIncomingResponseFromTransport(message) Handle an incoming response message from the transport.
register(request, delegate) Send REGISTER.
replyStateless(message, options) A stateless UAS is a UAS that does not maintain transaction state. It replies to requests normally, but discards any state that would ordinarily be retained by a UAS after a response has been sent. If a stateless UAS receives a retransmission of a request, it regenerates the response and re-sends it, just as if it were replying to the first instance of the request. A UAS cannot be stateless unless the request processing for that method would always result in the same response if the requests are identical. This rules out stateless registrars, for example. Stateless UASs do not use a transaction layer; they receive requests directly from the transport layer and send responses directly to the transport layer. https://tools.ietf.org/html/rfc3261\#section-8.2.7
request(request, delegate) Send a request.
reset() Reset.
subscribe(request, delegate) Send SUBSCRIBE.