Class OutgoingResponse

Represents the response to an incoming request. It's returned by Object#dispatch.

Index

Constructors

Properties

exceptionDetails exceptionId outputStream replyStatus size

Constructors

constructor

new OutgoingResponse(
    outputStream: OutputStream,
    replyStatus: ReplyStatus,
    exceptionId?: string,
    exceptionDetails?: string,
): OutgoingResponse
Constructs an outgoing response.
Parameters
- outputStream: OutputStream
  The output stream that holds the response.
- replyStatus: ReplyStatus
  The reply status.
- OptionalexceptionId: string
  The ID of the exception, when the response carries an exception other than a user exception.
- OptionalexceptionDetails: string
  The full details of the exception, when the response carries an exception other than a user exception.
Returns OutgoingResponse

Properties

exceptionDetails

exceptionDetails: string

The exception details marshaled into the response. It's null when replyStatus is ReplyStatus.Ok or ReplyStatus.UserException.

exceptionId

exceptionId: string

The exception ID of the response. It's null when replyStatus is ReplyStatus.Ok or ReplyStatus.UserException.

outputStream

outputStream: OutputStream

The output stream buffer of the response. This output stream should not be written to after construction.

replyStatus

replyStatus: ReplyStatus

The reply status of the response.

size

size: number

The number of bytes in the response's payload.