@zeroc/ice
    Preparing search index...

    Class OutgoingResponse

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

    Index

    Constructors

    constructor

    Properties

    exceptionDetails exceptionId outputStream replyStatus size

    Constructors

    • Constructs an outgoing response.

      Parameters

      • outputStream: OutputStream

        The output stream that holds the response.

      • OptionalreplyStatus: ReplyStatus

        The status of the response. Defaults to ReplyStatus.Ok.

      • OptionalexceptionId: string | null

        The type ID of the exception, when the response carries an exception other than a user exception.

      • OptionalexceptionDetails: string | null

        The full details of the exception, when the response carries an exception other than a user exception.

      Returns OutgoingResponse

    Properties

    exceptionDetails: string | null

    The full details of the exception (typically the Error stack), used for logging; not marshaled into the response. It's null when replyStatus is ReplyStatus.Ok or ReplyStatus.UserException.

    exceptionId: string | null

    The exception ID of the response. It's null when replyStatus is ReplyStatus.Ok or ReplyStatus.UserException. Otherwise, this ID is the value returned by LocalException#ice_id. For other exceptions, this ID is the value returned by Error#name.

    outputStream: OutputStream

    The output stream buffer of the response.

    replyStatus: ReplyStatus

    The reply status of the response.

    size: number

    The number of bytes in the response's payload.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties