Module com.zeroc.ice

Package com.zeroc.Ice

Class OutgoingResponse

java.lang.Object

com.zeroc.Ice.OutgoingResponse

public final class OutgoingResponse
extends Object

Represents the response to an incoming request. It's returned by Object.dispatch(IncomingRequest).

Field Summary

Fields

Modifier and Type	Field	Description
final String	exceptionDetails	Gets the full details of the exception marshaled into the response.
final String	exceptionId	Gets the exception ID of the response.
final OutputStream	outputStream	Gets the output stream buffer of the response.
final int	replyStatus	Gets the reply status of the response, as an int.
final int	size	Gets the number of bytes in the response's payload.

Constructor Summary

Constructors

Constructor	Description
OutgoingResponse(int replyStatus, String exceptionId, String exceptionDetails, OutputStream outputStream)	Constructs an OutgoingResponse object.
OutgoingResponse(OutputStream outputStream)	Constructs an OutgoingResponse object with the ReplyStatus.Ok status.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

exceptionId

public final String exceptionId

Gets 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 full name of the exception's type.

exceptionDetails

public final String exceptionDetails

Gets the full details of the exception marshaled into the response.

The exception details. It's null when replyStatus is ReplyStatus.Ok or ReplyStatus.UserException.

outputStream

public final OutputStream outputStream

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

replyStatus

public final int replyStatus

Gets the reply status of the response, as an int.

size

public final int size

Gets the number of bytes in the response's payload.

Constructor Details

OutgoingResponse

public OutgoingResponse(int replyStatus,
 String exceptionId,
 String exceptionDetails,
 OutputStream outputStream)

Constructs an OutgoingResponse object.

Parameters:

replyStatus - The reply status, as an int.

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

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

outputStream - The output stream that holds the response.

OutgoingResponse

public OutgoingResponse(OutputStream outputStream)

Constructs an OutgoingResponse object with the ReplyStatus.Ok status.

Parameters:

outputStream - The output stream that holds the response.