sip.js.useragentserver.md
September 26, 2022 ยท View on GitHub
Home > sip.js > UserAgentServer
UserAgentServer class
User Agent Server (UAS).
Signature:
export declare class UserAgentServer implements IncomingRequest
Implements: IncomingRequest
Remarks
A user agent server is a logical entity that generates a response to a SIP request. The response accepts, rejects, or redirects the request. This role lasts only for the duration of that transaction. In other words, if a piece of software responds to a request, it acts as a UAS for the duration of that transaction. If it generates a request later, it assumes the role of a user agent client for the processing of that transaction. https://tools.ietf.org/html/rfc3261\#section-6
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(transactionConstructor, core, message, delegate) | Constructs a new instance of the UserAgentServer class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| acceptable | boolean | ||
| core | UserAgentCore | ||
| delegate | IncomingRequestDelegate | undefined | ||
| logger | Logger | ||
| loggerFactory | LoggerFactory | ||
| message | IncomingRequestMessage | ||
| progressable | boolean | ||
| redirectable | boolean | ||
| rejectable | boolean | ||
| toTag | string | ||
| transaction | ServerTransaction | The transaction associated with this request. | |
| tryingable | boolean |
Methods
| Method | Modifiers | Description |
|---|---|---|
| accept(options) | ||
| dispose() | ||
| progress(options) | ||
| receiveCancel(message) | If the UAS did not find a matching transaction for the CANCEL according to the procedure above, it SHOULD respond to the CANCEL with a 481 (Call Leg/Transaction Does Not Exist). If the transaction for the original request still exists, the behavior of the UAS on receiving a CANCEL request depends on whether it has already sent a final response for the original request. If it has, the CANCEL request has no effect on the processing of the original request, no effect on any session state, and no effect on the responses generated for the original request. If the UAS has not issued a final response for the original request, its behavior depends on the method of the original request. If the original request was an INVITE, the UAS SHOULD immediately respond to the INVITE with a 487 (Request Terminated). A CANCEL request has no impact on the processing of transactions with any other method defined in this specification. https://tools.ietf.org/html/rfc3261\#section-9.2 | |
| redirect(contacts, options) | ||
| reject(options) | ||
| trying(options) |