Ice

AMDCallback is the interface from which all AMD callbacks are derived.

Indicates to the Ice run time that an operation completed with a run-time exception.

The encoded Ice run-time exception. Note that, if ex is a user exception, the caller receives UnknownUserException. Use ice_response to raise user exceptions.

The signal policy for Ice.Application signal handling.

If a signal is received, Ice.Application reacts to the signal by calling Communicator.destroy or Communicator.shutdown, or by calling a custom shutdown hook installed by the application.

Any signal that is received is not intercepted and takes the default action.

Utility base class that makes it easy to correctly initialize and finalize the Ice run time, as well as handle signals. Unless the application specifies a logger, Application installs a per-process logger that logs to the standard error output. Applications must create a derived class that implements the run method. A program can contain only one instance of this class.

Called once the communicator has been initialized. The derived class must implement run, which is the application's starting method.

The argument vector for the application. Application scans the argument vector passed to main for options that are specific to the Ice run time and removes them; therefore, the vector passed to run is free from Ice-related options and contains only options and arguments that are application-specific. The run method should return zero for successful termination, and non-zero otherwise. Application.main returns the value returned by run.

Override this method to provide a custom application interrupt hook. You must call callbackOnInterrupt for this method to be called. Note that the interruptCallback can be called concurrently with any other thread (including main) in your application--take appropriate concurrency precautions.

The cause of the interrupt.

Initializes an instance that calls Communicator.shutdown if a signal is received.

Initializes an instance that handles signals according to the signal policy.

Determines how to respond to signals.

The application must call main after it has instantiated the derived class. main creates a communicator, establishes the specified signal policy, and, once run returns, destroys the communicator. The method prints an error message for any exception that propagates out of run and ensures that the communicator is destroyed correctly even if run completes abnormally.

The arguments for the application (as passed to Main(string[]) by the operating system. The value returned by run. If run terminates with an exception, the return value is non-zero.

The arguments for the application (as passed to Main(string[]) by the operating system. The configuration file with which to initialize Ice properties. The value returned by run. If run terminates with an exception, the return value is non-zero.

The arguments for the application (as passed to Main(string[]) by the operating system. Additional data used to initialize the communicator. The value returned by run. If run terminates with an exception, the return value is non-zero.

Returns the application name (which is also the value of Ice.ProgramName. This method is useful mainly for error messages that include the application name. Because appName is a static method, it is available from anywhere in the program.

The name of the application.

Returns the communicator for the application. Because communicator is a static method, it permits access to the communicator from anywhere in the program. Note that, as a consequence, you cannot have more than one instance of Application in a program.

The communicator for the application.

Instructs Application to call Communicator.destroy on receipt of a signal. This is default signal handling policy established by the default constructor.

Instructs Application to call Communicator.shutdown on receipt of a signal.

Instructs Application to ignore signals.

Instructs Application to call interruptCallback on receipt of a signal. The derived class can intercept signals by overriding interruptCallback.

Instructs Application to call to hold signals.

Instructs Application respond to signals. If a signal arrived since the last call to holdInterrupt, it is delivered once you call releaseInterrupt.

Determines whether the application shut down intentionally or was forced to shut down due to a signal. This is useful for logging purposes.

True if a signal caused the communicator to shut down; false otherwise.

Callback that requires the application to down-cast the proxy.

Callback for the successful completion of an operation that returns no data.

Called when an invocation raises an exception.

Confirms the queuing of the batch request.

Get the marshalled size of the request.

The request size.

Get the name of the operation

The request operation.

The proxy used to invoke the batch request.

The request proxy.

Base interface for listening to batch request queues.

Called by the Ice runtime when a batch request is about to be added to the batch request queue of a proxy or connection. The implementation of this method must call enqueue() on the request to confirm its addition to the queue, if not called the request isn't added to the queue. The implementation can raise an Ice local exception to notify the caller of a failure.

The batch request. The number of batch request queued. The size of the queued batch requests.

Destroy the communicator. This operation calls shutdown implicitly. Calling destroy cleans up memory, and shuts down this communicator's client functionality and destroys all object adapters. Subsequent calls to destroy are ignored.

Shuts down this communicator's server functionality, which includes the deactivation of all object adapters. (Attempts to use a deactivated object adapter raise ObjectAdapterDeactivatedException.) Subsequent calls to shutdown are ignored. After shutdown returns, no new requests are processed. However, requests that have been started before shutdown was called might still be active. You can use waitForShutdown to wait for the completion of all requests.

Wait until the application has called shutdown (or destroy). On the server side, this operation blocks the calling thread until all currently-executing operations have completed. On the client side, the operation simply block until another thread has called shutdown or destroy. A typical use of this operation is to call it from the main thread, which then waits until some other thread calls shutdown. After shut-down is complete, the main thread returns and can do some cleanup work before it finally calls destroy to shut down the client functionality, and then exits the application.

Check whether communicator has been shut down.

True if the communicator has been shut down; false otherwise.

Convert a stringified proxy into a proxy. For example, MyCategory/MyObject:tcp -h some_host -p 10000 creates a proxy that refers to the Ice object having an identity with a name "MyObject" and a category "MyCategory", with the server running on host "some_host", port 10000. If the stringified proxy does not parse correctly, the operation throws one of ProxyParseException, EndpointParseException, or IdentityParseException. An appendix in the Ice manual provides a detailed description of the syntax supported by stringified proxies.

The stringified proxy to convert into a proxy. The proxy, or nil if str is an empty string.

Convert a proxy into a string.

The proxy to convert into a stringified proxy. The stringified proxy, or an empty string if obj is nil.

Convert a set of proxy properties into a proxy. The "base" name supplied in the property argument refers to a property containing a stringified proxy, such as MyProxy=id:tcp -h localhost -p 10000. Additional properties configure local settings for the proxy, such as MyProxy.PreferSecure=1. The "Properties" appendix in the Ice manual describes each of the supported proxy properties.

The base property name. The proxy.

Convert a proxy to a set of proxy properties.

The proxy. The base property name. The property set.

Convert a string into an identity. If the string does not parse correctly, the operation throws IdentityParseException.

The string to convert into an identity. The identity.

Convert an identity into a string.

The identity to convert into a string. The "stringified" identity.

Create a new object adapter. The endpoints for the object adapter are taken from the property name.Endpoints. It is legal to create an object adapter with the empty string as its name. Such an object adapter is accessible via bidirectional connections or by collocated invocations that originate from the same communicator as is used by the adapter. Attempts to create a named object adapter for which no configuration can be found raise InitializationException.

The object adapter name. The new object adapter.

Create a new object adapter with endpoints. This operation sets the property name.Endpoints, and then calls createObjectAdapter. It is provided as a convenience function. Calling this operation with an empty name will result in a UUID being generated for the name.

The object adapter name. The endpoints for the object adapter. The new object adapter.

Create a new object adapter with a router. This operation creates a routed object adapter. Calling this operation with an empty name will result in a UUID being generated for the name.

The object adapter name. The router. The new object adapter.

Add an object factory to this communicator. Installing a factory with an id for which a factory is already registered throws AlreadyRegisteredException. When unmarshaling an Ice object, the Ice run time reads the most-derived type id off the wire and attempts to create an instance of the type using a factory. If no instance is created, either because no factory was found, or because all factories returned nil, the behavior of the Ice run time depends on the format with which the object was marshaled: If the object uses the "sliced" format, Ice ascends the class hierarchy until it finds a type that is recognized by a factory, or it reaches the least-derived type. If no factory is found that can create an instance, the run time throws NoObjectFactoryException. If the object uses the "compact" format, Ice immediately raises NoObjectFactoryException. The following order is used to locate a factory for a type: The Ice run-time looks for a factory registered specifically for the type. If no instance has been created, the Ice run-time looks for the default factory, which is registered with an empty type id. If no instance has been created by any of the preceding steps, the Ice run-time looks for a factory that may have been statically generated by the language mapping for non-abstract classes.

The factory to add. The type id for which the factory can create instances, or an empty string for the default factory.

Find an object factory registered with this communicator.

The type id for which the factory can create instances, or an empty string for the default factory. The object factory, or null if no object factory was found for the given id.

Get the implicit context associated with this communicator.

The implicit context associated with this communicator; returns null when the property Ice.ImplicitContext is not set or is set to None.

Get the properties for this communicator.

This communicator's properties.

Get the logger for this communicator.

This communicator's logger.

Get the observer resolver object for this communicator.

This communicator's observer resolver object.

Get the default router this communicator.

The default router for this communicator.

Set a default router for this communicator. All newly created proxies will use this default router. To disable the default router, null can be used. Note that this operation has no effect on existing proxies. You can also set a router for an individual proxy by calling the operation ice_router on the proxy.

The default router to use for this communicator.

Get the default locator this communicator.

The default locator for this communicator.

Set a default Ice locator for this communicator. All newly created proxy and object adapters will use this default locator. To disable the default locator, null can be used. Note that this operation has no effect on existing proxies or object adapters. You can also set a locator for an individual proxy by calling the operation ice_locator on the proxy, or for an object adapter by calling the operation ObjectAdapter.setLocator on the object adapter.

The default locator to use for this communicator.

Get the plug-in manager for this communicator.

This communicator's plug-in manager.

Flush any pending batch requests for this communicator. This means all batch requests invoked on fixed proxies for all connections associated with the communicator. Any errors that occur while flushing a connection are ignored.

Add the Admin object with all its facets to the provided object adapter. If Ice.Admin.ServerId is set and the provided object adapter has a Locator, createAdmin registers the Admin's Process facet with the Locator's LocatorRegistry. createAdmin call only be called once; subsequent calls raise InitializationException.

The object adapter used to host the Admin object; if null and Ice.Admin.Endpoints is set, create, activate and use the Ice.Admin object adapter. The identity of the Admin object. A proxy to the main ("") facet of the Admin object. Never returns a null proxy.

Get a proxy to the main facet of the Admin object. getAdmin also creates the Admin object and creates and activates the Ice.Admin object adapter to host this Admin object if Ice.Admin.Enpoints is set. The identity of the Admin object created by getAdmin is /admin, or /admin when Ice.Admin.InstanceName is not set. If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator initialization, after initialization of all plugins.

A proxy to the main ("") facet of the Admin object, or a null proxy if no Admin object is configured.

Add a new facet to the Admin object. Adding a servant with a facet that is already registered throws AlreadyRegisteredException.

The servant that implements the new Admin facet. The name of the new Admin facet.

Remove the following facet to the Admin object. Removing a facet that was not previously registered throws NotRegisteredException.

The name of the Admin facet. The servant associated with this Admin facet.

Returns a facet of the Admin object.

The name of the Admin facet. The servant associated with this Admin facet, or null if no facet is registered with the given name.

Returns a map of all facets of the Admin object.

A collection containing all the facet names and servants of the Admin object.

Close a connection, either gracefully or forcefully. If a connection is closed forcefully, it closes immediately, without sending the relevant close connection protocol messages to the peer and waiting for the peer to acknowledge these protocol messages.

If true, close forcefully. Otherwise the connection is closed gracefully.

Create a special proxy that always uses this connection. This can be used for callbacks from a server to a client if the server cannot directly establish a connection to the client, for example because of firewalls. In this case, the server would create a proxy using an already established connection from the client.

The identity for which a proxy is to be created. A proxy that matches the given identity and uses this connection.

Explicitly set an object adapter that dispatches requests that are received over this connection. A client can invoke an operation on a server using a proxy, and then set an object adapter for the outgoing connection that is used by the proxy in order to receive callbacks. This is useful if the server cannot establish a connection back to the client, for example because of firewalls.

The object adapter that should be used by this connection to dispatch requests. The object adapter must be activated. When the object adapter is deactivated, it is automatically removed from the connection.

Get the object adapter that dispatches requests for this connection.

The object adapter that dispatches requests for the connection, or null if no adapter is set.

Get the endpoint from which the connection was created.

The endpoint from which the connection was created.

Flush any pending batch requests for this connection. This means all batch requests invoked on fixed proxies associated with the connection.

Set callback on the connection. The callback is called by the connection when it's closed. The callback is called from the Ice thread pool associated with the connection.

The connection callback object.

Set the active connection management parameters.

The timeout value in milliseconds. The close condition The hertbeat condition

Get the ACM parameters.

The ACM parameters.

Return the connection type. This corresponds to the endpoint type, i.e., "tcp", "udp", etc.

The type of the connection.

Get the timeout for the connection.

The connection's timeout.

Return a description of the connection as human readable text, suitable for logging or error messages.

The description of the connection as human readable text.

Returns the connection information.

The connection information.

Set the connectiion buffer receive/send size.

The connection receive buffer size. The connection send buffer size.

Base class that allows a server intercept incoming requests. The application must derive a concrete class from DispatchInterceptor that implements the DispatchInterceptor.dispatch operation. An instance of this derived class can be registered with an object adapter like any other servant. A dispatch interceptor is useful particularly to automatically retry requests that have failed due to a recoverable error condition.

Base class for all Slice classes.

the base interface for servants.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. True if this object has the interface specified by s or derives from the interface specified by s.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. The Current object for the invocation. True if this object has the interface specified by s or derives from the interface specified by s.

Tests whether this object can be reached.

The Current object for the invocation.

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

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.

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

The Current object for the invocation. 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.

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

The Slice type ID of the most-derived interface.

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

The Current object for the invocation. The Slice type ID of the most-derived interface.

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.

This 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.

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

The details of the invocation. The callback object for asynchchronous dispatch. For synchronous dispatch, the callback object must be null. The dispatch status for the operation.

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

The details of the invocation. The dispatch status for the operation.

Instantiates an Ice object.

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

The cloned object.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. The return value is true if s is ::Ice::Object.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. The Current object for the invocation. The return value is true if s is ::Ice::Object.

Tests whether this object can be reached.

Tests whether this object can be reached. The Current object for the invocation.

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

An array whose only element is ::Ice::Object.

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

The Current object for the invocation. An array whose only element is ::Ice::Object.

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

The return value is always ::Ice::Object.

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

The Current object for the invocation. The return value is always ::Ice::Object.

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

The return value is always ::Ice::Object.

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.

This 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.

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

The details of the invocation. The callback object for asynchchronous dispatch. For synchronous dispatch, the callback object must be null. The dispatch status for the operation.

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

The details of the invocation. The dispatch status for the operation.

Called by the Ice run time to dispatch an incoming request. The implementation of dispatch must dispatch the request to the actual servant.

The details of the incoming request. For synchronous dispatch, the return value must be whatever is returned ice_dispatch. For asynchronous dispatch, the return value must be DispatchAsync.

Return a string representation of the endpoint.

The string representation of the endpoint.

Returns the endpoint information.

The endpoint information class.

Base class for Ice exceptions.

Creates and returns a copy of this exception.

A copy of this exception.

Creates a default-initialized exception.

Creates a default-initialized exception and sets the InnerException property to the passed exception.

The inner exception.

Initializes a new instance of the exception with serialized data.

Holds the serialized object data about the exception being thrown. Contains contextual information about the source or destination.

Returns the name of this exception.

The name of this exception.

Returns a string representation of this exception, including any inner exceptions.

The string representation of this exception.

Base class for local exceptions.

Creates a default-initialized local exception.

Creates a default-initialized local exception and sets the InnerException property to the passed exception.

The inner exception.

Initializes a new instance of the exception with serialized data.

Holds the serialized object data about the exception being thrown. Contains contextual information about the source or destination.

Base class for Ice run-time exceptions.

Creates a default-initialized run-time exception.

Creates a default-initialized run-time exception and sets the InnerException property to the passed exception.

The inner exception.

Initializes a new instance of the exception with serialized data.

Holds the serialized object data about the exception being thrown. Contains contextual information about the source or destination.

Base class for Slice user exceptions.

Creates a default-initialized user exception.

Creates a default-initialized user exception and sets the InnerException property to the passed exception.

The inner exception.

Initializes a new instance of the exception with serialized data.

Holds the serialized object data about the exception being thrown. Contains contextual information about the source or destination.

This enumeration describes the possible formats for classes and exceptions.

Get a copy of the underlying context.

A copy of the underlying context.

Set the underlying context.

The new context.

Check if this key has an associated value in the underlying context.

The key. True if the key has an associated value, False otherwise.

Get the value associated with the given key in the underlying context. Returns an empty string if no value is associated with the key. containsKey allows you to distinguish between an empty-string value and no value at all.

The key. The value associated with the key.

Create or update a key/value entry in the underlying context.

The key. The value. The previous value associated with the key, if any.

Remove the entry for the given key in the underlying context.

The key. The value associated with the key, if any.

Interface for incoming requests.

Returns the {@link Current} object for this the request.

The Current object for this request.

Callback interface for Blobject AMD servants.

Indicates to the Ice run time that an operation completed.

True indicates that the operation completed successfully; false indicates that the operation raised a user exception. The encoded out-parameters for the operation or, if ok is false, the encoded user exception.

Update connection observers associated with each of the Ice connection from the communicator and its object adapters. When called, this method goes through all the connections and for each connection CommunicatorObserver.getConnectionObserver is called. The implementation of getConnectionObserver has the possibility to return an updated observer if necessary.

Update thread observers associated with each of the Ice thread from the communicator and its object adapters. When called, this method goes through all the threads and for each thread CommunicatorObserver.getThreadObserver is called. The implementation of getThreadObserver has the possibility to return an updated observer if necessary.

This method is called when the instrumented object is created or when the observer is attached to an existing object.

This method is called when the instrumented object is destroyed and as a result the observer detached from the object.

Notification of a failure.

The name of the exception.

Notification of sent bytes over the connection.

The number of bytes sent.

Notification of received bytes over the connection.

The number of bytes received.

Notification of a user exception.

Reply notification.

The size of the reply.

Reply notification.

The size of the reply.

Notification of the invocation being retried.

Notification of a user exception.

Get a remote observer for this invocation.

The connection information. The connection endpoint. The ID of the invocation. The size of the invocation. The observer to instrument the remote invocation.

Get a collocated observer for this invocation.

The object adapter hosting the collocated Ice object. The ID of the invocation. The size of the invocation. The observer to instrument the collocated invocation.

Notification of thread state change.

The previous thread state. The new thread state.

This method should return an observer for the given endpoint information and connector. The Ice run-time calls this method for each connection establishment attempt.

The endpoint. The description of the connector. For IP transports, this is typically the IP address to connect to. The observer to instrument the connection establishment.

This method should return an observer for the given endpoint information. The Ice run-time calls this method to resolve an endpoint and obtain the list of connectors. For IP endpoints, this typically involves doing a DNS lookup to obtain the IP addresses associated with the DNS name.

The endpoint. The observer to instrument the endpoint lookup.

This method should return a connection observer for the given connection. The Ice run-time calls this method for each new connection and for all the Ice communicator connections when ObserverUpdater.updateConnectionObservers is called.

The connection information. The connection endpoint. The state of the connection. The old connection observer if one is already set or a null reference otherwise. The connection observer to instrument the connection.

This method should return a thread observer for the given thread. The Ice run-time calls this method for each new thread and for all the Ice communicator threads when ObserverUpdater.updateThreadObservers is called.

The parent of the thread. The ID of the thread to observe. The state of the thread. The old thread observer if one is already set or a null reference otherwise. The thread observer to instrument the thread.

This method should return an invocation observer for the given invocation. The Ice run-time calls this method for each new invocation on a proxy.

The proxy used for the invocation. The name of the invocation. The context specified by the user. The invocation observer to instrument the invocation.

This method should return a dispatch observer for the given dispatch. The Ice run-time calls this method each time it receives an incoming invocation to be dispatched for an Ice object.

The current object as provided to the Ice servant dispatching the invocation. The size of the dispatch. The dispatch observer to instrument the dispatch.

The Ice run-time calls this method when the communicator is initialized. The add-in implementing this interface can use this object to get the Ice run-time to re-obtain observers for observed objects.

The observer updater object.

Returns the type of the endpoint.

Returns true if this endpoint is a datagram endpoint.

Returns true if this endpoint is a secure endpoint.

The interface of the admin object that allows an Ice application the attach its RemoteLogger to the Logger of this admin object's Ice communicator.

attachRemoteLogger is called to attach a RemoteLogger object to the local Logger. attachRemoteLogger calls init on the provided RemoteLogger proxy.

A proxy to the remote logger. The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types). The categories of traces that the remote logger wishes to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories). The maximum number of log messages (of all types) to be provided to RemoteLogger.init. A negative value requests all messages available. Raised if this remote logger is already attached to this admin object. The Current object for the invocation.

detachRemoteLogger is called to detach a RemoteLogger object from the local Logger.

A proxy to the remote logger. True if the provided remote logger proxy was detached, and false otherwise. The Current object for the invocation.

getLog retrieves log messages recently logged.

The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types). The categories of traces that caller wish to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories). The maximum number of log messages (of all types) to be returned. A negative value requests all messages available. The prefix of the associated local Logger. The Log messages. The Current object for the invocation.

The interface of the admin object that allows an Ice application the attach its RemoteLogger to the Logger of this admin object's Ice communicator.

attachRemoteLogger is called to attach a RemoteLogger object to the local Logger. attachRemoteLogger calls init on the provided RemoteLogger proxy.

detachRemoteLogger is called to detach a RemoteLogger object from the local Logger.

A proxy to the remote logger. True if the provided remote logger proxy was detached, and false otherwise.

getLog retrieves log messages recently logged.

Print a message. The message is printed literally, without any decorations such as executable name or time stamp.

Log a trace message.

The trace category. The trace message to log.

Log a warning message.

The warning message to log.

Log an error message.

The error message to log.

Returns this logger's prefix.

The prefix.

Returns a clone of the logger with a new prefix.

The new prefix for the logger.

Class to support custom loggers. Applications using a custom logger instantiate a LoggerPlugin with a custom logger and return the instance from their PluginFactory implementation.

Perform any necessary initialization steps.

Called when the communicator is being destroyed.

Installs a custom logger for a communicator.

The communicator using the custom logger. The custom logger for the communicator.

Called by the Ice run time during communicator initialization. The derived class can override this method to perform any initialization that might be required by a custom logger.

Called by the Ice run time when the communicator is destroyed. The derived class can override this method to perform any finalization that might be required by a custom logger.

The metrics administrative facet interface. This interface allows remote administrative clients to access metrics of an application that enabled the Ice administrative facility and configured some metrics views.

Get the names of enabled and disabled metrics.

The names of the disabled views. The name of the enabled views. The Current object for the invocation.

Enables a metrics view.

The metrics view name. Raised if the metrics view cannot be found. The Current object for the invocation.

Disable a metrics view.

The metrics view name. Raised if the metrics view cannot be found. The Current object for the invocation.

Get the metrics objects for the given metrics view. This returns a dictionnary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.

The name of the metrics view. The local time of the process when the metrics object were retrieved. The metrics view data. Raised if the metrics view cannot be found. The Current object for the invocation.

Get the metrics failures associated with the given view and map.

The name of the metrics view. The name of the metrics map. The metrics failures associated with the map. Raised if the metrics view cannot be found. The Current object for the invocation.

Get the metrics failure associated for the given metrics.

The name of the metrics view. The name of the metrics map. The ID of the metrics. The metrics failures associated with the metrics. Raised if the metrics view cannot be found. The Current object for the invocation.

Get the names of enabled and disabled metrics.

The names of the disabled views. The name of the enabled views.

Enables a metrics view.

The metrics view name. Raised if the metrics view cannot be found.

Disable a metrics view.

The metrics view name. Raised if the metrics view cannot be found.

The name of the metrics view. The local time of the process when the metrics object were retrieved. The metrics view data. Raised if the metrics view cannot be found.

Get the metrics failures associated with the given view and map.

The name of the metrics view. The name of the metrics map. The metrics failures associated with the map. Raised if the metrics view cannot be found.

Get the metrics failure associated for the given metrics.

The name of the metrics view. The name of the metrics map. The ID of the metrics. The metrics failures associated with the metrics. Raised if the metrics view cannot be found.

Indicates the status of operation dispatch.

Indicates that an operation was dispatched synchronously and successfully.

Indicates that an operation was dispatched synchronously and raised a user exception.

Indicates that an operation was dispatched asynchronously.

Base class for dynamic dispatch servants. A server application derives a concrete servant class from Blobject that implements the Blobject.ice_invoke method.

Dispatch an incoming request.

The encoded in-parameters for the operation. The encoded out-paramaters and return value for the operation. The return value follows any out-parameters. The Current object to pass to the operation. If the operation completed successfully, the return value is true. If the operation raises a user exception, the return value is false; in this case, outParams must contain the encoded user exception. If the operation raises an Ice run-time exception, it must throw it directly.

Get the name of this object adapter.

This object adapter's name.

Get the communicator this object adapter belongs to.

This object adapter's communicator.

Activate all endpoints that belong to this object adapter. After activation, the object adapter can dispatch requests received through its endpoints.

Temporarily hold receiving and dispatching requests. The object adapter can be reactivated with the activate operation. Holding is not immediate, i.e., after hold returns, the object adapter might still be active for some time. You can use waitForHold to wait until holding is complete.

Wait until the object adapter holds requests. Calling hold initiates holding of requests, and waitForHold only returns when holding of requests has been completed.

Deactivate all endpoints that belong to this object adapter. After deactivation, the object adapter stops receiving requests through its endpoints. Object adapters that have been deactivated must not be reactivated again, and cannot be used otherwise. Attempts to use a deactivated object adapter raise ObjectAdapterDeactivatedException; however, attempts to deactivate an already deactivated object adapter are ignored and do nothing. Once deactivated, it is possible to destroy the adapter to clean up resources and then create and activate a new adapter with the same name. After deactivate returns, no new requests are processed by the object adapter. However, requests that have been started before deactivate was called might still be active. You can use waitForDeactivate to wait for the completion of all requests for this object adapter.

Wait until the object adapter has deactivated. Calling deactivate initiates object adapter deactivation, and waitForDeactivate only returns when deactivation has been completed.

Check whether object adapter has been deactivated.

Whether adapter has been deactivated.

Destroys the object adapter and cleans up all resources held by the object adapter. If the object adapter has not yet been deactivated, destroy implicitly initiates the deactivation and waits for it to finish. Subsequent calls to destroy are ignored. Once destroy has returned, it is possible to create another object adapter with the same name.

Add a servant to this object adapter's Active Servant Map. Note that one servant can implement several Ice objects by registering the servant with multiple identities. Adding a servant with an identity that is in the map already throws AlreadyRegisteredException.

The servant to add. The identity of the Ice object that is implemented by the servant. A proxy that matches the given identity and this object adapter.

Like add, but with a facet. Calling add(servant, id) is equivalent to calling addFacet with an empty facet.

The servant to add. The identity of the Ice object that is implemented by the servant. The facet. An empty facet means the default facet. A proxy that matches the given identity, facet, and this object adapter.

Add a servant to this object adapter's Active Servant Map, using an automatically generated UUID as its identity. Note that the generated UUID identity can be accessed using the proxy's ice_getIdentity operation.

The servant to add. A proxy that matches the generated UUID identity and this object adapter.

Like addWithUUID, but with a facet. Calling addWithUUID(servant) is equivalent to calling addFacetWithUUID with an empty facet.

The servant to add. The facet. An empty facet means the default facet. A proxy that matches the generated UUID identity, facet, and this object adapter.

Add a default servant to handle requests for a specific category. Adding a default servant for a category for which a default servant is already registered throws AlreadyRegisteredException. To dispatch operation calls on servants, the object adapter tries to find a servant for a given Ice object identity and facet in the following order: The object adapter tries to find a servant for the identity and facet in the Active Servant Map. If no servant has been found in the Active Servant Map, the object adapter tries to find a default servant for the category component of the identity. If no servant has been found by any of the preceding steps, the object adapter tries to find a default servant for an empty category, regardless of the category contained in the identity. If no servant has been found by any of the preceding steps, the object adapter gives up and the caller receives ObjectNotExistException or FacetNotExistException.

The default servant. The category for which the default servant is registered. An empty category means it will handle all categories.

Remove a servant (that is, the default facet) from the object adapter's Active Servant Map.

The identity of the Ice object that is implemented by the servant. If the servant implements multiple Ice objects, remove has to be called for all those Ice objects. Removing an identity that is not in the map throws NotRegisteredException. The removed servant.

Like remove, but with a facet. Calling remove(id) is equivalent to calling removeFacet with an empty facet.

The identity of the Ice object that is implemented by the servant. The facet. An empty facet means the default facet. The removed servant.

Remove all facets with the given identity from the Active Servant Map. The operation completely removes the Ice object, including its default facet. Removing an identity that is not in the map throws NotRegisteredException.

The identity of the Ice object to be removed. A collection containing all the facet names and servants of the removed Ice object.

Remove the default servant for a specific category. Attempting to remove a default servant for a category that is not registered throws NotRegisteredException.

The category of the default servant to remove. The default servant.

Look up a servant in this object adapter's Active Servant Map by the identity of the Ice object it implements. This operation only tries to look up a servant in the Active Servant Map. It does not attempt to find a servant by using any installed ServantLocator.

The identity of the Ice object for which the servant should be returned. The servant that implements the Ice object with the given identity, or null if no such servant has been found.

Like find, but with a facet. Calling find(id) is equivalent to calling findFacet with an empty facet.

The identity of the Ice object for which the servant should be returned. The facet. An empty facet means the default facet. The servant that implements the Ice object with the given identity and facet, or null if no such servant has been found.

Find all facets with the given identity in the Active Servant Map.

The identity of the Ice object for which the facets should be returned. A collection containing all the facet names and servants that have been found, or an empty map if there is no facet for the given identity.

Look up a servant in this object adapter's Active Servant Map, given a proxy. This operation only tries to lookup a servant in the Active Servant Map. It does not attempt to find a servant by using any installed ServantLocator.

The proxy for which the servant should be returned. The servant that matches the proxy, or null if no such servant has been found.

Add a Servant Locator to this object adapter. Adding a servant locator for a category for which a servant locator is already registered throws AlreadyRegisteredException. To dispatch operation calls on servants, the object adapter tries to find a servant for a given Ice object identity and facet in the following order: The object adapter tries to find a servant for the identity and facet in the Active Servant Map. If no servant has been found in the Active Servant Map, the object adapter tries to find a servant locator for the category component of the identity. If a locator is found, the object adapter tries to find a servant using this locator. If no servant has been found by any of the preceding steps, the object adapter tries to find a locator for an empty category, regardless of the category contained in the identity. If a locator is found, the object adapter tries to find a servant using this locator. If no servant has been found by any of the preceding steps, the object adapter gives up and the caller receives ObjectNotExistException or FacetNotExistException. Only one locator for the empty category can be installed.

The locator to add. The category for which the Servant Locator can locate servants, or an empty string if the Servant Locator does not belong to any specific category.

Remove a Servant Locator from this object adapter.

The category for which the Servant Locator can locate servants, or an empty string if the Servant Locator does not belong to any specific category. The Servant Locator, or throws NotRegisteredException if no Servant Locator was found for the given category.

Find a Servant Locator installed with this object adapter.

The category for which the Servant Locator can locate servants, or an empty string if the Servant Locator does not belong to any specific category. The Servant Locator, or null if no Servant Locator was found for the given category.

Find the default servant for a specific category.

The category of the default servant to find. The default servant or null if no default servant was registered for the category.

Create a proxy for the object with the given identity. If this object adapter is configured with an adapter id, the return value is an indirect proxy that refers to the adapter id. If a replica group id is also defined, the return value is an indirect proxy that refers to the replica group id. Otherwise, if no adapter id is defined, the return value is a direct proxy containing this object adapter's published endpoints.

The object's identity. A proxy for the object with the given identity.

Create a direct proxy for the object with the given identity. The returned proxy contains this object adapter's published endpoints.

The object's identity. A proxy for the object with the given identity.

Create an indirect proxy for the object with the given identity. If this object adapter is configured with an adapter id, the return value refers to the adapter id. Otherwise, the return value contains only the object identity.

The object's identity. A proxy for the object with the given identity.

Set an Ice locator for this object adapter. By doing so, the object adapter will register itself with the locator registry when it is activated for the first time. Furthermore, the proxies created by this object adapter will contain the adapter identifier instead of its endpoints. The adapter identifier must be configured using the AdapterId property.

The locator used by this object adapter.

Get the Ice locator used by this object adapter.

The locator used by this object adapter, or null if no locator is used by this object adapter.

Refresh the set of published endpoints. The run time re-reads the PublishedEndpoints property if it is set and re-reads the list of local interfaces if the adapter is configured to listen on all endpoints. This operation is useful to refresh the endpoint information that is published in the proxies that are created by an object adapter if the network interfaces used by a host changes.

Get the set of endpoints configured with this object adapter.

The set of endpoints.

Get the set of endpoints that proxies created by this object adapter will contain.

The set of published endpoints.

Encapsulates an optional value. Instances of this type are immutable.

Creates an optional value whose state is unset.

Creates an optional value and sets its value to the given argument.

Creates an optional value whose state is copied from the given argument.

Initializes a new instance of the exception with serialized data.

Holds the serialized object data about the exception being thrown. Contains contextual information about the source or destination.

Conversion operator to the underlying type; a cast is required. An exception is raised if no value is set.

The encapsulated value. Thrown if no value is set.

Conversion operator from a value of the underlying type; no cast is required.

Conversion operator from a None value; no cast is required.

Serializes an optional value.

Holds the serialized object data about the exception being thrown. Contains contextual information about the source or destination.

Reads and writes the encapsulated value.

Thrown if the property is read and no value is set.

Determines whether a value is set.

True if a value is set, false otherwise.

Handles callbacks for an optional object parameter.

Callback class to inform an application when a Slice class has been unmarshaled from an input stream.

The Ice run time calls this method when it has fully unmarshaled the state of a Slice class.

The unmarshaled Slice class.

Instantiates the class with the given optional.

The Slice type ID corresponding to the formal type.

Sets the Ice object of the optional to the passed instance.

The new object for the optional.

The target optional.

The optional format. An optional value is encoded with a specific optional format. This optional format describes how the data is encoded and how it can be skipped by the unmarshaling code if the optional is not known to the receiver.

Applications implement this interface to provide a plug-in factory to the Ice run time.

Called by the Ice run time to create a new plug-in.

The communicator that is in the process of being initialized. The name of the plug-in. The arguments that are specified in the plug-ins configuration. The plug-in that was created by this method.

Initialize the configured plug-ins. The communicator automatically initializes the plug-ins by default, but an application may need to interact directly with a plug-in prior to initialization. In this case, the application must set Ice.InitPlugins=0 and then invoke initializePlugins manually. The plug-ins are initialized in the order in which they are loaded. If a plug-in raises an exception during initialization, the communicator invokes destroy on the plug-ins that have already been initialized.

Raised if the plug-ins have already been initialized.

Get a list of plugins installed.

The names of the plugins installed.

Obtain a plug-in by name.

The plug-in's name. The plug-in. Raised if no plug-in is found with the given name.

Install a new plug-in.

The plug-in's name. The plug-in. Raised if a plug-in already exists with the given name.

Called when the communicator is being destroyed.

An administrative interface for process management. Managed servers must implement this interface. A servant implementing this interface is a potential target for denial-of-service attacks, therefore proper security precautions should be taken. For example, the servant can use a UUID to make its identity harder to guess, and be registered in an object adapter with a secured endpoint.

Initiate a graceful shut-down.

The Current object for the invocation.

Write a message on the process' stdout or stderr.

The message. 1 for stdout, 2 for stderr. The Current object for the invocation.

Initiate a graceful shut-down.

Write a message on the process' stdout or stderr.

The message. 1 for stdout, 2 for stderr.

The PropertiesAdmin interface provides remote access to the properties of a communicator.

Get a property by key. If the property is not set, an empty string is returned.

The property key. The property value. The Current object for the invocation.

Get all properties whose keys begin with prefix. If prefix is an empty string then all properties are returned.

The prefix to search for (empty string if none). The matching property set. The Current object for the invocation.

Update the communicator's properties with the given property set.

The callback object for the operation. Properties to be added, changed, or removed. If an entry in newProperties matches the name of an existing property, that property's value is replaced with the new value. If the new value is an empty string, the property is removed. Any existing properties that are not modified or removed by the entries in newProperties are retained with their original values. The Current object for the invocation.

The PropertiesAdmin interface provides remote access to the properties of a communicator.

Get a property by key. If the property is not set, an empty string is returned.

The property key. The property value.

Get all properties whose keys begin with prefix. If prefix is an empty string then all properties are returned.

The prefix to search for (empty string if none). The matching property set.

Update the communicator's properties with the given property set.

Get a property by key. If the property is not set, an empty string is returned.

The property key. The property value.

Get a property by key. If the property is not set, the given default value is returned.

The property key. The default value to use if the property does not exist. The property value or the default value.

Get a property as an integer. If the property is not set, 0 is returned.

The property key. The property value interpreted as an integer.

Get a property as an integer. If the property is not set, the given default value is returned.

The property key. The default value to use if the property does not exist. The property value interpreted as an integer, or the default value.

Get a property as a list of strings. The strings must be separated by whitespace or comma. If the property is not set, an empty list is returned. The strings in the list can contain whitespace and commas if they are enclosed in single or double quotes. If quotes are mismatched, an empty list is returned. Within single quotes or double quotes, you can escape the quote in question with \, e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.

The property key. The property value interpreted as a list of strings.

Get a property as a list of strings. The strings must be separated by whitespace or comma. If the property is not set, the default list is returned. The strings in the list can contain whitespace and commas if they are enclosed in single or double quotes. If quotes are mismatched, the default list is returned. Within single quotes or double quotes, you can escape the quote in question with \, e.g. O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.

The property key. The default value to use if the property is not set. The property value interpreted as list of strings, or the default value.

Get all properties whose keys begins with prefix. If prefix is an empty string, then all properties are returned.

The prefix to search for (empty string if none). The matching property set.

Set a property. To unset a property, set it to the empty string.

The property key. The property value.

Get a sequence of command-line options that is equivalent to this property set. Each element of the returned sequence is a command-line option of the form --key=value.

The command line options for this property set.

Convert a sequence of command-line options into properties. All options that begin with --prefix. are converted into properties. If the prefix is empty, all options that begin with -- are converted to properties.

The property prefix, or an empty string to convert all options starting with --. The command-line options. The command-line options that do not start with the specified prefix, in their original order.

Convert a sequence of command-line options into properties. All options that begin with one of the following prefixes are converted into properties: --Ice, --IceBox, --IceGrid, --IcePatch2, --IceSSL, --IceStorm, --Freeze, and --Glacier2.

The command-line options. The command-line options that do not start with one of the listed prefixes, in their original order.

Load properties from a file.

The property file.

Create a copy of this property set.

A copy of this property set.

Delegate for a successful ice_isA invocation. True if the remote object supports the type, false otherwise.

Delegate for a successful ice_ids invocation. The array of Slice type ids supported by the remote object.

Delegate for a successful ice_id invocation. The Slice type id of the most-derived interface supported by the remote object.

Delegate for a successful ice_ping invocation.

Delegate for a successful ice_invoke invocation. True if the invocation succeeded, or false if the invocation raised a user exception. The encoded out-parameters or user exception.

Delegate for a successful ice_getConnection invocation. The connection used by the proxy.

Base interface of all object proxies.

Returns the communicator that created this proxy.

The communicator that created this proxy.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. True if the target object has the interface specified by id__ or derives from the interface specified by id__.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. The context dictionary for the invocation. True if the target object has the interface specified by id__ or derives from the interface specified by id__.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. An asynchronous result object.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. The context dictionary for the invocation. An asynchronous result object.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

Tests whether this object supports a specific Slice interface.

The type ID of the Slice interface to test against. The context dictionary for the invocation. A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

Tests whether this object supports a specific Slice interface.

The asynchronous result object returned by begin_ice_isA. True if the object supports the Slice interface, false otherwise.

Tests whether the target object of this proxy can be reached.

The context dictionary for the invocation.

Tests whether the target object of this proxy can be reached.

An asynchronous result object.

Tests whether the target object of this proxy can be reached.

The context dictionary for the invocation. An asynchronous result object.

Tests whether the target object of this proxy can be reached.

A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

Tests whether the target object of this proxy can be reached.

The context dictionary for the invocation. A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

Tests whether the target object of this proxy can be reached.

The asynchronous result object returned by begin_ice_ping.

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

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

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

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

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

An asynchronous result object.

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

The context dictionary for the invocation. An asynchronous result object.

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

A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

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

The context dictionary for the invocation. A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

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

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

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

The Slice type ID of the most-derived interface.

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

The context dictionary for the invocation. The Slice type ID of the most-derived interface.

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

An asynchronous result object.

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

The context dictionary for the invocation. An asynchronous result object.

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

A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

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

The context dictionary for the invocation. A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

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

The asynchronous result object returned by begin_ice_id. The Slice type ID of the most-derived interface.

Invokes an operation dynamically.

The name of the operation to invoke. The operation mode (normal or idempotent). The encoded in-parameters for the operation. The encoded out-paramaters and return value for the operation. The return value follows any out-parameters. If the operation completed successfully, the return value is true. If the operation raises a user exception, the return value is false; in this case, outEncaps contains the encoded user exception. If the operation raises a run-time exception, it throws it directly.

Invokes an operation dynamically.

The name of the operation to invoke. The operation mode (normal or idempotent). The encoded in-parameters for the operation. The encoded out-paramaters and return value for the operation. The return value follows any out-parameters. The context dictionary for the invocation. If the operation completed successfully, the return value is true. If the operation raises a user exception, the return value is false; in this case, outEncaps contains the encoded user exception. If the operation raises a run-time exception, it throws it directly.

Invokes an operation dynamically.

The name of the operation to invoke. The operation mode (normal or idempotent). The encoded in-parameters for the operation. An asynchronous result object.

Invokes an operation dynamically.

The name of the operation to invoke. The operation mode (normal or idempotent). The encoded in-parameters for the operation. The context dictionary for the invocation. An asynchronous result object.

Invokes an operation dynamically.

The name of the operation to invoke. The operation mode (normal or idempotent). The encoded in-parameters for the operation. A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

Invokes an operation dynamically.

The name of the operation to invoke. The operation mode (normal or idempotent). The encoded in-parameters for the operation. The context dictionary for the invocation. A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

Completes a dynamic invocation.

The encoded out parameters or user exception. The asynchronous result object returned by begin_ice_invoke. If the operation completed successfully, the return value is true. If the operation raises a user exception, the return value is false; in this case, outEncaps contains the encoded user exception. If the operation raises a run-time exception, it throws it directly.

Returns the identity embedded in this proxy. The identity of the target object.

Creates a new proxy that is identical to this proxy, except for the per-proxy context. The identity for the new proxy. The proxy with the new identity.

Returns the per-proxy context for this proxy.

The per-proxy context. If the proxy does not have a per-proxy (implicit) context, the return value is null.

Creates a new proxy that is identical to this proxy, except for the per-proxy context.

The context for the new proxy. The proxy with the new per-proxy context.

Returns the facet for this proxy.

The facet for this proxy. If the proxy uses the default facet, the return value is the empty string.

Creates a new proxy that is identical to this proxy, except for the facet.

The facet for the new proxy. The proxy with the new facet.

Returns the adapter ID for this proxy.

The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string.

Creates a new proxy that is identical to this proxy, except for the adapter ID.

The adapter ID for the new proxy. The proxy with the new adapter ID.

Returns the endpoints used by this proxy.

The endpoints used by this proxy.

Creates a new proxy that is identical to this proxy, except for the endpoints.

The endpoints for the new proxy. The proxy with the new endpoints.

Returns the locator cache timeout of this proxy.

The locator cache timeout value (in seconds).

Creates a new proxy that is identical to this proxy, except for the locator cache timeout.

The new locator cache timeout (in seconds).

Creates a new proxy that is identical to this proxy, except for the invocation timeout.

The new invocation timeout (in seconds).

Returns the invocation timeout of this proxy.

The invocation timeout value (in seconds).

Returns whether this proxy caches connections.

True if this proxy caches connections; false, otherwise.

Creates a new proxy that is identical to this proxy, except for connection caching.

True if the new proxy should cache connections; false, otherwise. The new proxy with the specified caching policy.

Returns how this proxy selects endpoints (randomly or ordered).

The endpoint selection policy.

Creates a new proxy that is identical to this proxy, except for the endpoint selection policy.

The new endpoint selection policy. The new proxy with the specified endpoint selection policy.

Returns whether this proxy communicates only via secure endpoints.

True if this proxy communicates only vi secure endpoints; false, otherwise.

Creates a new proxy that is identical to this proxy, except for how it selects endpoints.

If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints. The new proxy with the specified selection policy.

Creates a new proxy that is identical to this proxy, except for the encoding used to marshal parameters.

The encoding version to use to marshal requests parameters. The new proxy with the specified encoding version.

Returns the encoding version used to marshal requests parameters.

The encoding version.

Returns whether this proxy prefers secure endpoints.

True if the proxy always attempts to invoke via secure endpoints before it attempts to use insecure endpoints; false, otherwise.

Creates a new proxy that is identical to this proxy, except for its endpoint selection policy.

If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones. The new proxy with the new endpoint selection policy.

Returns the router for this proxy.

The router for the proxy. If no router is configured for the proxy, the return value is null.

Creates a new proxy that is identical to this proxy, except for the router.

The router for the new proxy. The new proxy with the specified router.

Returns the locator for this proxy.

The locator for this proxy. If no locator is configured, the return value is null.

Creates a new proxy that is identical to this proxy, except for the locator.

The locator for the new proxy. The new proxy with the specified locator.

Returns whether this proxy uses collocation optimization.

True if the proxy uses collocation optimization; false, otherwise.

Creates a new proxy that is identical to this proxy, except for collocation optimization.

True if the new proxy enables collocation optimization; false, otherwise. The new proxy the specified collocation optimization.

Creates a new proxy that is identical to this proxy, but uses twoway invocations.

A new proxy that uses twoway invocations.

Returns whether this proxy uses twoway invocations.

True if this proxy uses twoway invocations; false, otherwise.

Creates a new proxy that is identical to this proxy, but uses oneway invocations.

A new proxy that uses oneway invocations.

Returns whether this proxy uses oneway invocations.

True if this proxy uses oneway invocations; false, otherwise.

Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.

A new proxy that uses batch oneway invocations.

Returns whether this proxy uses batch oneway invocations.

True if this proxy uses batch oneway invocations; false, otherwise.

Creates a new proxy that is identical to this proxy, but uses datagram invocations.

A new proxy that uses datagram invocations.

Returns whether this proxy uses datagram invocations.

True if this proxy uses datagram invocations; false, otherwise.

Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.

A new proxy that uses batch datagram invocations.

Returns whether this proxy uses batch datagram invocations.

True if this proxy uses batch datagram invocations; false, otherwise.

Creates a new proxy that is identical to this proxy, except for compression.

True enables compression for the new proxy; false disables compression. A new proxy with the specified compression setting.

Creates a new proxy that is identical to this proxy, except for its timeout setting.

The timeout for the new proxy in milliseconds. A new proxy with the specified timeout.

Creates a new proxy that is identical to this proxy, except for its connection ID.

The connection ID for the new proxy. An empty string removes the connection ID. A new proxy with the specified connection ID.

Returns the connection id of this proxy.

The connection id.

Returns the Connection for this proxy. If the proxy does not yet have an established connection, it first attempts to create a connection.

The Connection for this proxy. If the proxy uses collocation optimization and denotes a collocated object.

Asynchronously gets the connection for this proxy.

An asynchronous result object.

Asynchronously gets the connection for this proxy.

A callback to be invoked when the invocation completes. Application-specific data to be stored in the result. An asynchronous result object.

Asynchronously gets the connection for this proxy.

The asynchronous result object returned by begin_ice_getConnection. The connection.

Returns the cached Connection for this proxy. If the proxy does not yet have an established connection, it does not attempt to create a connection.

The cached Connection for this proxy (null if the proxy does not have an established connection). If the proxy uses collocation optimization and denotes a collocated object.

Flushes any pending batched requests for this communicator. The call blocks until the flush is complete.

Base class of all object proxies.

Returns a hash code for this proxy.

The hash code.

Returns the communicator that created this proxy.

The communicator that created this proxy.

Returns the stringified form of this proxy.

The stringified proxy.