Ice::Communicator

Overview

local interface Communicator

The central object in Ice. One or more communicators can be instantiated for an Ice application. Communicator instantiation is language-specific, and not specified in Slice code.

Used By

::Freeze::Connection::getCommunicator
::IceBox::Service::start
ObjectAdapter::getCommunicator

Operation Index

destroy: Destroy the communicator.
shutdown: Shuts down this communicator's server functionality, which includes the deactivation of all object adapters.
waitForShutdown: Wait until the application has called shutdown (or destroy).
isShutdown: Check whether communicator has been shut down.
stringToProxy: Convert a string into a proxy.
proxyToString: Convert a proxy into a string.
propertyToProxy: Convert a set of proxy properties into a proxy.
stringToIdentity: Convert a string into an identity.
identityToString: Convert an identity into a string.
createObjectAdapter: Create a new object adapter.
createObjectAdapterWithEndpoints: Create a new object adapter with endpoints.
createObjectAdapterWithRouter: Create a new object adapter with a router.
addObjectFactory: Add a servant factory to this communicator.
findObjectFactory: Find a servant factory registered with this communicator.
getDefaultContext: Get the currently-set default context.
Deprecated.
setDefaultContext: Set a default context on this communicator.
Deprecated.
getImplicitContext: Get the implicit context associated with this communicator.
getProperties: Get the properties for this communicator.
getLogger: Get the logger for this communicator.
getStats: Get the statistics callback object for this communicator.
getDefaultRouter: Get the default router this communicator.
setDefaultRouter: Set a default router for this communicator.
getDefaultLocator: Get the default locator this communicator.
setDefaultLocator: Set a default Ice locator for this communicator.
getPluginManager: Get the plug-in manager for this communicator.
flushBatchRequests: Flush any pending batch requests for this communicator.
getAdmin: Get a proxy to the main facet of the Admin object.
addAdminFacet: Add a new facet to the Admin object.
removeAdminFacet: Remove the following facet to the Admin object.

Operations

void destroy()

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.

void shutdown()

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.

void waitForShutdown()

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.

bool isShutdown()

Check whether communicator has been shut down.

Return Value

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

Object* stringToProxy(string str)

Convert a string 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 string does not parse correctly, the operation throws ProxyParseException.

Parameters

str: The string to convert into a proxy.

Return Value

The proxy.

string proxyToString(Object* obj)

Convert a proxy into a string.

Parameters

obj: The proxy to convert into a string.

Return Value

The "stringified" proxy.

Object* propertyToProxy(string property)

Convert a set of proxy properties into a proxy.

Parameters

property: The base property name.

Return Value

The proxy.

Identity stringToIdentity(string str)

Convert a string into an identity.

Parameters

str: The string to convert into an identity.

Return Value

The identity.

string identityToString(Identity ident)

Convert an identity into a string.

Parameters

ident: The identity to convert into a string.

Return Value

The "stringified" identity.

ObjectAdapter createObjectAdapter(string name)

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 cannot be accessed remotely and, therefore, is accessible only for collocated invocations that originate from the the same communicator as is used by the adapter.

Attempts to create a named object adapter for which no endpoint or router configuration can be found raise InitializationException.

Parameters

name: The object adapter name.

Return Value

The new object adapter.

ObjectAdapter createObjectAdapterWithEndpoints(string name, string endpoints)

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 or empty endpoint string raises InitializationException.

Parameters

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

Return Value

The new object adapter.

ObjectAdapter createObjectAdapterWithRouter(string name, Router* rtr)

Create a new object adapter with a router. This operation creates a routed object adapter.

Parameters

name: The object adapter name.
router: The router.

Return Value

The new object adapter.

void addObjectFactory(ObjectFactory factory, string id)

Add a servant 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 object is sliced to the next most-derived type and the process repeats. If no factory is found that can create an instance, the Ice run-time throws 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 emtpy 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.

Parameters

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

ObjectFactory findObjectFactory(string id)

Find a servant factory registered with this communicator.

Parameters

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

Return Value

The servant factory, or null if no servant factory was found for the given id.

Context getDefaultContext()

Get the currently-set default context.

This operation is deprecated as of version 3.2.

getDefaultContext is deprecated, use per-proxy contexts or implicit contexts (if applicable) instead.

Return Value

The currently established default context. If no default context is currently set, getDefaultContext returns an empty context.

void setDefaultContext(Context ctx)

Set a default context on this communicator. All newly created proxies will use this default context. This operation has no effect on existing proxies.

You can also set a context for an individual proxy by calling the operation ice_context on the proxy.

This operation is deprecated as of version 3.2.

setDefaultContext is deprecated, use per-proxy contexts or implicit contexts (if applicable) instead.

Parameters

ctx: The default context to be set.

ImplicitContext getImplicitContext()

Get the implicit context associated with this communicator.

Return Value

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

Properties getProperties()

Get the properties for this communicator.

Return Value

This communicator's properties.

Logger getLogger()

Get the logger for this communicator.

Return Value

This communicator's logger.

Stats getStats()

Get the statistics callback object for this communicator.

Return Value

This communicator's statistics callback object.

Router* getDefaultRouter()

Get the default router this communicator.

Return Value

The default router for this communicator.

void setDefaultRouter(Router* rtr)

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.

Parameters

rtr: The default router to use for this communicator.

Locator* getDefaultLocator()

Get the default locator this communicator.

Return Value

The default locator for this communicator.

void setDefaultLocator(Locator* loc)

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 setLocator on the object adapter.

Parameters

loc: The default locator to use for this communicator.

PluginManager getPluginManager()

Get the plug-in manager for this communicator.

Return Value

This communicator's plug-in manager.

void flushBatchRequests()

Flush any pending batch requests for this communicator. This causes all batch requests that were sent via proxies obtained via this communicator to be sent to the server.

Object* getAdmin()

Get a proxy to the main facet of the Admin object. When Ice.Admin.DelayCreation is greater than 0, it is necessary to call getAdmin() after the communicator is initialized to create the Admin object. Otherwise, the Admin object is created automatically after all the plugins are initialized.

Return Value

The main ("") facet of the Admin object; a null proxy if no Admin object is configured.

void addAdminFacet(Object servant, string facet)

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

Parameters

servant: The servant that implements the new Admin facet.
facet: The new Admin facet.

Object removeAdminFacet(string facet)

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

Parameters

facet: The Admin facet.

Return Value

The servant associated with this Admin facet

Ice::Communicator

Overview

local interface Communicator

Used By

See Also

Operation Index

Operations

void destroy()

See Also

void shutdown()

See Also

void waitForShutdown()

See Also

bool isShutdown()

Return Value

See Also

Object* stringToProxy(string str)

Parameters

Return Value

See Also

string proxyToString(Object* obj)

Parameters

Return Value

See Also

Object* propertyToProxy(string property)

Parameters

Return Value

Identity stringToIdentity(string str)

Parameters

Return Value

See Also

string identityToString(Identity ident)

Parameters

Return Value

See Also

ObjectAdapter createObjectAdapter(string name)

Parameters

Return Value

See Also

ObjectAdapter createObjectAdapterWithEndpoints(string name, string endpoints)

Parameters

Return Value

See Also

ObjectAdapter createObjectAdapterWithRouter(string name, Router* rtr)

Parameters

Return Value

See Also

void addObjectFactory(ObjectFactory factory, string id)

Parameters

See Also

ObjectFactory findObjectFactory(string id)

Parameters

Return Value

See Also

Context getDefaultContext()

Return Value

See Also

void setDefaultContext(Context ctx)

Parameters

See Also

ImplicitContext getImplicitContext()

Return Value

Properties getProperties()

Return Value

See Also

Logger getLogger()

Return Value

See Also

Stats getStats()

Return Value

See Also

Router* getDefaultRouter()

Return Value

See Also

void setDefaultRouter(Router* rtr)

Parameters

See Also

Locator* getDefaultLocator()

Return Value

See Also