The central object in Ice. More...

defined in <Ice/Communicator.ice>

["clr:implements:global::System.IDisposable","java:implements:java.lang.AutoCloseable"] local interface Communicator { ... }

Operations
void	addAdminFacet (["swift:nonnull"] Object servant, string facet)
	Add a new facet to the Admin object. More...

void	addObjectFactory (ObjectFactory factory, ["objc:param:sliceId"] string id)
	Add an object factory to this communicator. More...

Object *	createAdmin (ObjectAdapter adminAdapter, Identity adminId)
	Add the Admin object with all its facets to the provided object adapter. More...

ObjectAdapter	createObjectAdapter (string name)
	Create a new object adapter. More...

ObjectAdapter	createObjectAdapterWithEndpoints (string name, string endpoints)
	Create a new object adapter with endpoints. More...

ObjectAdapter	createObjectAdapterWithRouter (string name, ["objc:param:router", "swift:nonnull"] Router *rtr)
	Create a new object adapter with a router. More...

void	destroy ()
	Destroy the communicator. More...

Object	findAdminFacet (string facet)
	Returns a facet of the Admin object. More...

FacetMap	findAllAdminFacets ()
	Returns a map of all facets of the Admin object. More...

ObjectFactory	findObjectFactory (string id)
	Find an object factory registered with this communicator. More...

void	flushBatchRequests (CompressBatch compress)
	Flush any pending batch requests for this communicator. More...

Object *	getAdmin ()
	Get a proxy to the main facet of the Admin object. More...

Locator *	getDefaultLocator ()
	Get the default locator this communicator. More...

Router *	getDefaultRouter ()
	Get the default router this communicator. More...

ImplicitContext	getImplicitContext ()
	Get the implicit context associated with this communicator. More...

Logger	getLogger ()
	Get the logger for this communicator. More...

Instrumentation::CommunicatorObserver	getObserver ()
	Get the observer resolver object for this communicator. More...

PluginManager	getPluginManager ()
	Get the plug-in manager for this communicator. More...

Properties	getProperties ()
	Get the properties for this communicator. More...

ValueFactoryManager	getValueFactoryManager ()
	Get the value factory manager for this communicator. More...

string	identityToString (Identity ident)
	Convert an identity into a string. More...

bool	isShutdown ()
	Check whether communicator has been shut down. More...

Object *	propertyToProxy (string property)
	Convert a set of proxy properties into a proxy. More...

PropertyDict	proxyToProperty (["swift:nonnull"] Object *proxy, string property)
	Convert a proxy to a set of proxy properties. More...

string	proxyToString (Object *obj)
	Convert a proxy into a string. More...

Object	removeAdminFacet (string facet)
	Remove the following facet to the Admin object. More...

void	setDefaultLocator (Locator *loc)
	Set a default Ice locator for this communicator. More...

void	setDefaultRouter (Router *rtr)
	Set a default router for this communicator. More...

void	shutdown ()
	Shuts down this communicator's server functionality, which includes the deactivation of all object adapters. More...

Identity	stringToIdentity (string str)
	Convert a string into an identity. More...

Object *	stringToProxy (string str)
	Convert a stringified proxy into a proxy. More...

void	waitForShutdown ()
	Wait until the application has called shutdown (or destroy). More...

Detailed Description

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.

See also: Logger; ObjectAdapter; Properties; ValueFactory

Operation Documentation

◆ addAdminFacet()

void addAdminFacet	(	["swift:nonnull"] 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 name of the new Admin facet.

◆ addObjectFactory()

["deprecate:addObjectFactory() is deprecated, use ValueFactoryManager::add() instead."]

void addObjectFactory	(	ObjectFactory	factory,
		["objc:param:sliceId"] string	id
	)

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

If the object uses the "compact" format, Ice immediately raises NoValueFactoryException.

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.

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.

See also: findObjectFactory; ObjectFactory; ValueFactoryManager::add

◆ createAdmin()

["swift:nonnull"]

Object* createAdmin	(	ObjectAdapter	adminAdapter,
		Identity	adminId
	)

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 must only be called once; subsequent calls raise InitializationException.

Parameters

adminAdapter	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.
adminId	The identity of the Admin object.

Returns: A proxy to the main ("") facet of the Admin object. Never returns a null proxy.

See also: getAdmin

◆ createObjectAdapter()

["js:async","swift:nonnull"]

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

Parameters

name	The object adapter name.

Returns: The new object adapter.

See also: createObjectAdapterWithEndpoints; ObjectAdapter; Properties

◆ createObjectAdapterWithEndpoints()

["js:async","swift:nonnull"]

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 will result in a UUID being generated for the name.

Parameters

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

Returns: The new object adapter.

See also: createObjectAdapter; ObjectAdapter; Properties

◆ createObjectAdapterWithRouter()

["js:async","swift:nonnull"]

ObjectAdapter createObjectAdapterWithRouter	(	string	name,
		["objc:param:router", "swift:nonnull"] Router *	rtr
	)

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.

Parameters

name	The object adapter name.
rtr	The router.

Returns: The new object adapter.

See also: createObjectAdapter; ObjectAdapter; Properties

◆ destroy()

["cpp:noexcept","swift:noexcept","js:async"]

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.

See also: shutdown; ObjectAdapter::destroy

◆ findAdminFacet()

["swift:noexcept"]

Object findAdminFacet ( string facet )

Returns a facet of the Admin object.

Parameters

facet The name of the Admin facet.

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

◆ findAllAdminFacets()

["swift:noexcept"]

FacetMap findAllAdminFacets ( )

Returns a map of all facets of the Admin object.

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

See also: findAdminFacet

◆ findObjectFactory()

["cpp:const","cpp:noexcept","deprecate:findObjectFactory() is deprecated, use ValueFactoryManager::find() instead."]

ObjectFactory findObjectFactory ( string id )

Find an object 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.

Returns: The object factory, or null if no object factory was found for the given id.

See also: addObjectFactory; ObjectFactory; ValueFactoryManager::find

◆ flushBatchRequests()

["async-oneway"]

void flushBatchRequests ( CompressBatch compress )

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.

Parameters

compress Specifies whether or not the queued batch requests should be compressed before being sent over the wire.

◆ getAdmin()

["cpp:const"]

Object* getAdmin ( )

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 {value of Ice.Admin.InstanceName}/admin, or {UUID}/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.

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

See also: createAdmin

◆ getDefaultLocator()

["cpp:const","swift:noexcept"]

Locator* getDefaultLocator ( )

Get the default locator this communicator.

Returns: The default locator for this communicator.

See also: setDefaultLocator; Locator

◆ getDefaultRouter()

["cpp:const","swift:noexcept"]

Router* getDefaultRouter ( )

Get the default router this communicator.

Returns: The default router for this communicator.

See also: setDefaultRouter; Router

◆ getImplicitContext()

["cpp:const","cpp:noexcept","swift:noexcept","swift:nonnull"]

ImplicitContext getImplicitContext ( )

Get the implicit context associated with this communicator.

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

◆ getLogger()

["cpp:const","cpp:noexcept","swift:noexcept","swift:nonnull"]

Logger getLogger ( )

Get the logger for this communicator.

Returns: This communicator's logger.

See also: Logger

◆ getObserver()

["cpp:const","cpp:noexcept"]

Instrumentation::CommunicatorObserver getObserver ( )

Get the observer resolver object for this communicator.

Returns: This communicator's observer resolver object.

◆ getPluginManager()

["cpp:const"]

PluginManager getPluginManager ( )

Get the plug-in manager for this communicator.

Returns: This communicator's plug-in manager.

See also: PluginManager

◆ getProperties()

["cpp:const","cpp:noexcept","swift:noexcept","swift:nonnull"]

Properties getProperties ( )

Get the properties for this communicator.

Returns: This communicator's properties.

See also: Properties

◆ getValueFactoryManager()

["cpp:const","cpp:noexcept","swift:noexcept","swift:nonnull"]

ValueFactoryManager getValueFactoryManager ( )

Get the value factory manager for this communicator.

Returns: This communicator's value factory manager.

See also: ValueFactoryManager

◆ identityToString()

["cpp:const","swift:noexcept"]

string identityToString ( Identity ident )

Convert an identity into a string.

Parameters

ident The identity to convert into a string.

Returns: The "stringified" identity.

See also: stringToIdentity

◆ isShutdown()

["cpp:const","cpp:noexcept","swift:noexcept"]

bool isShutdown ( )

Check whether communicator has been shut down.

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

See also: shutdown

◆ propertyToProxy()

["cpp:const"]

Object* propertyToProxy ( string property )

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.

Parameters

property The base property name.

Returns: The proxy.

◆ proxyToProperty()

["cpp:const","swift:noexcept"]

PropertyDict proxyToProperty	(	["swift:nonnull"] Object *	proxy,
		string	property
	)

Convert a proxy to a set of proxy properties.

Parameters

proxy	The proxy.
property	The base property name.

Returns: The property set.

◆ proxyToString()

["cpp:const","swift:noexcept"]

string proxyToString ( Object * obj )

Convert a proxy into a string.

Parameters

obj	The proxy to convert into a stringified proxy.

Returns: The stringified proxy, or an empty string if obj is nil.

See also: stringToProxy

◆ removeAdminFacet()

["swift:nonnull","swift:attribute:@discardableResult"]

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 name of the Admin facet.

Returns: The servant associated with this Admin facet.

◆ setDefaultLocator()

["swift:noexcept"]

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

Parameters

loc	The default locator to use for this communicator.

See also: getDefaultLocator; Locator; ObjectAdapter::setLocator

◆ setDefaultRouter()

["swift:noexcept"]

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.

See also: getDefaultRouter; createObjectAdapterWithRouter; Router

◆ shutdown()

["cpp:noexcept","swift:noexcept","js:async"]

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.

See also: destroy; waitForShutdown; ObjectAdapter::deactivate

◆ stringToIdentity()

["cpp:const","deprecate:stringToIdentity() is deprecated, use the static stringToIdentity() method instead."]

Identity stringToIdentity ( string str )

Convert a string into an identity.

If the string does not parse correctly, the operation throws IdentityParseException.

Parameters

str	The string to convert into an identity.

Returns: The identity.

See also: identityToString

◆ stringToProxy()

["cpp:const"]

Object* stringToProxy ( string str )

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. Refer to the Ice manual for a detailed description of the syntax supported by stringified proxies.

Parameters

str	The stringified proxy to convert into a proxy.

Returns: The proxy, or nil if str is an empty string.

See also: proxyToString

◆ waitForShutdown()

["cpp:noexcept","swift:noexcept","js:async"]

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

See also: shutdown; destroy; ObjectAdapter::waitForDeactivate

The documentation for this interface was generated from the following file:

Ice/Communicator.ice

Operations

Detailed Description

Operation Documentation

◆ addAdminFacet()

◆ addObjectFactory()

◆ createAdmin()

◆ createObjectAdapter()

◆ createObjectAdapterWithEndpoints()

◆ createObjectAdapterWithRouter()

◆ destroy()

◆ findAdminFacet()

◆ findAllAdminFacets()

◆ findObjectFactory()

◆ flushBatchRequests()

◆ getAdmin()

◆ getDefaultLocator()

◆ getDefaultRouter()

◆ getImplicitContext()

◆ getLogger()

◆ getObserver()

◆ getPluginManager()

◆ getProperties()

◆ getValueFactoryManager()

◆ identityToString()

◆ isShutdown()

◆ propertyToProxy()

◆ proxyToProperty()

◆ proxyToString()

◆ removeAdminFacet()

◆ setDefaultLocator()

◆ setDefaultRouter()

◆ shutdown()

◆ stringToIdentity()

◆ stringToProxy()

◆ waitForShutdown()