Ice

Interface Object

All Known Subinterfaces:

Locator, LocatorFinder, LocatorRegistry, LoggerAdmin, MetricsAdmin, Process, PropertiesAdmin, RemoteLogger, Router, RouterFinder

All Known Implementing Classes:

_LocatorDisp, _LocatorFinderDisp, _LocatorRegistryDisp, _LoggerAdminDisp, _MetricsAdminDisp, _ProcessDisp, _PropertiesAdminDisp, _RemoteLoggerDisp, _RouterDisp, _RouterFinderDisp, Blobject, BlobjectAsync, ChildInvocationMetrics, CollocatedMetrics, ConnectionMetrics, DispatchInterceptor, DispatchMetrics, InvocationMetrics, Metrics, MetricsAdminI, ObjectImpl, ObjectReader, ObjectWriter, ProcessI, RemoteMetrics, ThreadMetrics, UnknownSlicedObject

public interface Object

The base interface for servants.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ice_staticId

Method Summary

Modifier and Type	Method and Description
DispatchStatus	__dispatch(Incoming in, Current current)
void	__read(BasicStream __is)
void	__read(InputStream __inS)
void	__write(BasicStream __os)
void	__write(OutputStream __outS)
Object	clone() Returns a copy of the object.
DispatchStatus	ice_dispatch(Request request) Dispatches an invocation to a servant.
DispatchStatus	ice_dispatch(Request request, DispatchInterceptorAsyncCallback cb) Dispatches an invocation to a servant.
java.lang.String	ice_id() Returns the Slice type ID of the most-derived interface supported by this object.
java.lang.String	ice_id(Current current) Returns the Slice type ID of the most-derived interface supported by this object.
java.lang.String[]	ice_ids() Returns the Slice type IDs of the interfaces supported by this object.
java.lang.String[]	ice_ids(Current current) Returns the Slice type IDs of the interfaces supported by this object.
boolean	ice_isA(java.lang.String s) Tests whether this object supports a specific Slice interface.
boolean	ice_isA(java.lang.String s, Current current) Tests whether this object supports a specific Slice interface.
int	ice_operationAttributes(java.lang.String operation) Returns the Freeze metadata attributes for an operation.
void	ice_ping() Tests whether this object can be reached.
void	ice_ping(Current current) Tests whether this object can be reached.
void	ice_postUnmarshal() The Ice run time invokes this method vafter unmarshaling an object's data members.
void	ice_preMarshal() The Ice run time invokes this method prior to marshaling an object's data members.

Field Detail

ice_staticId

static final java.lang.String ice_staticId

See Also:

Constant Field Values

Method Detail

clone

Object clone()
      throws java.lang.CloneNotSupportedException

Returns a copy of the object. The cloned object contains field-for-field copies of the state.

Returns:

The cloned object.

Throws:

java.lang.CloneNotSupportedException - If cloning is not supported by the implementation.

ice_isA

boolean ice_isA(java.lang.String s)

Tests whether this object supports a specific Slice interface.

Parameters:

s - The type ID of the Slice interface to test against.

Returns:

true if this object has the interface specified by s or derives from the interface specified by s.

ice_isA

boolean ice_isA(java.lang.String s,
                Current current)

Tests whether this object supports a specific Slice interface.

Parameters:

s - The type ID of the Slice interface to test against.

current - The Current object for the invocation.

Returns:

true if this object has the interface specified by s or derives from the interface specified by s.

ice_ping

void ice_ping()

Tests whether this object can be reached.

ice_ping

void ice_ping(Current current)

Tests whether this object can be reached.

Parameters:

current - The Current object for the invocation.

ice_ids

java.lang.String[] ice_ids()

Returns the Slice type IDs of the interfaces supported by this object.

Returns:

The Slice type IDs of the interfaces supported by this object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

ice_ids

java.lang.String[] ice_ids(Current current)

Returns the Slice type IDs of the interfaces supported by this object.

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type IDs of the interfaces supported by this object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

ice_id

java.lang.String ice_id()

Returns the Slice type ID of the most-derived interface supported by this object.

Returns:

The Slice type ID of the most-derived interface.

ice_id

java.lang.String ice_id(Current current)

Returns the Slice type ID of the most-derived interface supported by this object.

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type ID of the most-derived interface.

ice_operationAttributes

int ice_operationAttributes(java.lang.String operation)

Returns the Freeze metadata attributes for an operation.

Parameters:

operation - The name of the operation.

Returns:

The least significant bit indicates whether the operation is a read or write operation. If the bit is set, the operation is a write operation. The expression ice_operationAttributes("op") & 0x1 is true if the operation has a ["freeze:write"] metadata directive.

The second and third least significant bit indicate the transactional mode of the operation. The expression ice_operationAttributes("op") & 0x6 >> 1 indicates the transactional mode as follows:

0

["freeze:read:supports"]

1

["freeze:read:mandatory"] or ["freeze:write:mandatory"]

2

["freeze:read:required"] or ["freeze:write:required"]

3

["freeze:read:never"]

ice_preMarshal

void ice_preMarshal()

The Ice run time invokes this method prior to marshaling an object's data members. This allows a subclass to override this method in order to validate its data members.

ice_postUnmarshal

void ice_postUnmarshal()

The Ice run time invokes this method vafter unmarshaling an object's data members. This allows a subclass to override this method in order to perform additional initialization.

ice_dispatch

DispatchStatus ice_dispatch(Request request,
                            DispatchInterceptorAsyncCallback cb)

Dispatches an invocation to a servant. This method is used by dispatch interceptors to forward an invocation to a servant (or to another interceptor).

Parameters:

request - The details of the invocation.

cb - The callback object for asynchronous dispatch. For synchronous dispatch, the callback object must be null.

Returns:

The dispatch status for the operation.

See Also:

DispatchInterceptor, DispatchInterceptorAsyncCallback, DispatchStatus

ice_dispatch

DispatchStatus ice_dispatch(Request request)

Dispatches an invocation to a servant. This method is used by dispatch interceptors to forward an invocation to a servant (or to another interceptor).

Parameters:

request - The details of the invocation.

Returns:

The dispatch status for the operation.

See Also:

DispatchInterceptor, DispatchStatus

__dispatch

DispatchStatus __dispatch(Incoming in,
                          Current current)

__write

void __write(BasicStream __os)

__read

void __read(BasicStream __is)

__write

void __write(OutputStream __outS)

__read

void __read(InputStream __inS)