The object adapter provides an up-call interface from the Ice run time to the implementation of Ice objects. More...

defined in <Ice/ObjectAdapter.ice>

local interface ObjectAdapter { ... }

Operations
void	activate ()
	Activate all endpoints that belong to this object adapter. More...

Object *	add (["swift:nonnull"] Object servant, ["objc:param:identity"] Identity id)
	Add a servant to this object adapter's Active Servant Map. More...

void	addDefaultServant (["swift:nonnull"] Object servant, string category)
	Add a default servant to handle requests for a specific category. More...

Object *	addFacet (["swift:nonnull"] Object servant, ["objc:param:identity"] Identity id, string facet)
	Like add, but with a facet. More...

Object *	addFacetWithUUID (["swift:nonnull"] Object servant, string facet)
	Like addWithUUID, but with a facet. More...

void	addServantLocator (["swift:nonnull"] ServantLocator locator, string category)
	Add a Servant Locator to this object adapter. More...

Object *	addWithUUID (["swift:nonnull"] Object servant)
	Add a servant to this object adapter's Active Servant Map, using an automatically generated UUID as its identity. More...

Object *	createDirectProxy (Identity id)
	Create a direct proxy for the object with the given identity. More...

Object *	createIndirectProxy (Identity id)
	Create an indirect proxy for the object with the given identity. More...

Object *	createProxy (Identity id)
	Create a proxy for the object with the given identity. More...

void	deactivate ()
	Deactivate all endpoints that belong to this object adapter. More...

void	destroy ()
	Destroys the object adapter and cleans up all resources held by the object adapter. More...

Object	find (Identity id)
	Look up a servant in this object adapter's Active Servant Map by the identity of the Ice object it implements. More...

FacetMap	findAllFacets (Identity id)
	Find all facets with the given identity in the Active Servant Map. More...

Object	findByProxy (["swift:nonnull"] Object *proxy)
	Look up a servant in this object adapter's Active Servant Map, given a proxy. More...

Object	findDefaultServant (string category)
	Find the default servant for a specific category. More...

Object	findFacet (Identity id, string facet)
	Like find, but with a facet. More...

ServantLocator	findServantLocator (string category)
	Find a Servant Locator installed with this object adapter. More...

Communicator	getCommunicator ()
	Get the communicator this object adapter belongs to. More...

EndpointSeq	getEndpoints ()
	Get the set of endpoints configured with this object adapter. More...

Locator *	getLocator ()
	Get the Ice locator used by this object adapter. More...

string	getName ()
	Get the name of this object adapter. More...

EndpointSeq	getPublishedEndpoints ()
	Get the set of endpoints that proxies created by this object adapter will contain. More...

void	hold ()
	Temporarily hold receiving and dispatching requests. More...

bool	isDeactivated ()
	Check whether object adapter has been deactivated. More...

void	refreshPublishedEndpoints ()
	Refresh the set of published endpoints. More...

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

FacetMap	removeAllFacets (Identity id)
	Remove all facets with the given identity from the Active Servant Map. More...

Object	removeDefaultServant (string category)
	Remove the default servant for a specific category. More...

Object	removeFacet (Identity id, string facet)
	Like remove, but with a facet. More...

ServantLocator	removeServantLocator (string category)
	Remove a Servant Locator from this object adapter. More...

void	setLocator (Locator *loc)
	Set an Ice locator for this object adapter. More...

void	setPublishedEndpoints (EndpointSeq newEndpoints)
	Set of the endpoints that proxies created by this object adapter will contain. More...

void	waitForDeactivate ()
	Wait until the object adapter has deactivated. More...

void	waitForHold ()
	Wait until the object adapter holds requests. More...

Detailed Description

The object adapter provides an up-call interface from the Ice run time to the implementation of Ice objects.

The object adapter is responsible for receiving requests from endpoints, and for mapping between servants, identities, and proxies.

See also: Communicator; ServantLocator

Operation Documentation

◆ activate()

["js:async"]

void activate ( )

Activate all endpoints that belong to this object adapter.

After activation, the object adapter can dispatch requests received through its endpoints.

See also: hold; deactivate

◆ add()

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

Object* add	(	["swift:nonnull"] Object	servant,
		["objc:param:identity"] Identity	id
	)

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.

Parameters

servant	The servant to add.
id	The identity of the Ice object that is implemented by the servant.

Returns: A proxy that matches the given identity and this object adapter.

See also: Identity; addFacet; addWithUUID; remove; find

◆ addDefaultServant()

void addDefaultServant	(	["swift:nonnull"] Object	servant,
		string	category
	)

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.

Parameters

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

See also: removeDefaultServant; findDefaultServant

◆ addFacet()

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

Object* addFacet	(	["swift:nonnull"] Object	servant,
		["objc:param:identity"] Identity	id,
		string	facet
	)

Like add, but with a facet.

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

Parameters

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

Returns: A proxy that matches the given identity, facet, and this object adapter.

See also: Identity; add; addFacetWithUUID; removeFacet; findFacet

◆ addFacetWithUUID()

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

Object* addFacetWithUUID	(	["swift:nonnull"] Object	servant,
		string	facet
	)

Like addWithUUID, but with a facet.

Calling addWithUUID(servant) is equivalent to calling addFacetWithUUID with an empty facet.

Parameters

servant	The servant to add.
facet	The facet. An empty facet means the default facet.

Returns: A proxy that matches the generated UUID identity, facet, and this object adapter.

See also: Identity; addFacet; addWithUUID; removeFacet; findFacet

◆ addServantLocator()

void addServantLocator	(	["swift:nonnull"] ServantLocator	locator,
		string	category
	)

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.

Parameters

locator	The locator to add.
category	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.

See also: Identity; removeServantLocator; findServantLocator; ServantLocator

◆ addWithUUID()

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

Object* addWithUUID ( ["swift:nonnull"] Object servant )

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.

Parameters

servant The servant to add.

Returns: A proxy that matches the generated UUID identity and this object adapter.

See also: Identity; add; addFacetWithUUID; remove; find

◆ createDirectProxy()

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

Object* createDirectProxy ( Identity id )

Create a direct proxy for the object with the given identity.

The returned proxy contains this object adapter's published endpoints.

Parameters

id	The object's identity.

Returns: A proxy for the object with the given identity.

See also: Identity

◆ createIndirectProxy()

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

Object* createIndirectProxy ( Identity id )

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.

Parameters

id	The object's identity.

Returns: A proxy for the object with the given identity.

See also: Identity

◆ createProxy()

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

Object* createProxy ( Identity id )

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.

Parameters

id	The object's identity.

Returns: A proxy for the object with the given identity.

See also: Identity

◆ deactivate()

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

void deactivate ( )

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.

See also: activate; hold; waitForDeactivate; Communicator::shutdown

◆ destroy()

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

void destroy ( )

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.

See also: deactivate; waitForDeactivate; Communicator::destroy

◆ find()

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

Object find ( Identity id )

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.

Parameters

id	The identity of the Ice object for which the servant should be returned.

Returns: The servant that implements the Ice object with the given identity, or null if no such servant has been found.

See also: Identity; findFacet; findByProxy

◆ findAllFacets()

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

FacetMap findAllFacets ( Identity id )

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

Parameters

id	The identity of the Ice object for which the facets should be returned.

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

See also: find; findFacet

◆ findByProxy()

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

Object findByProxy ( ["swift:nonnull"] Object * proxy )

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.

Parameters

proxy The proxy for which the servant should be returned.

Returns: The servant that matches the proxy, or null if no such servant has been found.

See also: find; findFacet

◆ findDefaultServant()

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

Object findDefaultServant ( string category )

Find the default servant for a specific category.

Parameters

category The category of the default servant to find.

Returns: The default servant or null if no default servant was registered for the category.

See also: addDefaultServant; removeDefaultServant

◆ findFacet()

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

Object findFacet	(	Identity	id,
		string	facet
	)

Like find, but with a facet.

Calling find(id) is equivalent to calling findFacet with an empty facet.

Parameters

id	The identity of the Ice object for which the servant should be returned.
facet	The facet. An empty facet means the default facet.

Returns: The servant that implements the Ice object with the given identity and facet, or null if no such servant has been found.

See also: Identity; find; findByProxy

◆ findServantLocator()

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

ServantLocator findServantLocator ( string category )

Find a Servant Locator installed with this object adapter.

Parameters

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

Returns: The Servant Locator, or null if no Servant Locator was found for the given category.

See also: Identity; addServantLocator; removeServantLocator; ServantLocator

◆ getCommunicator()

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

Communicator getCommunicator ( )

Get the communicator this object adapter belongs to.

Returns: This object adapter's communicator.

See also: Communicator

◆ getEndpoints()

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

EndpointSeq getEndpoints ( )

Get the set of endpoints configured with this object adapter.

Returns: The set of endpoints.

See also: Endpoint

◆ getLocator()

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

Locator* getLocator ( )

Get the Ice locator used by this object adapter.

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

See also: Locator; setLocator

◆ getName()

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

string getName ( )

Get the name of this object adapter.

Returns: This object adapter's name.

◆ getPublishedEndpoints()

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

EndpointSeq getPublishedEndpoints ( )

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

Returns: The set of published endpoints.

See also: refreshPublishedEndpoints; Endpoint

◆ hold()

["swift:noexcept"]

void hold ( )

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.

See also: activate; deactivate; waitForHold

◆ isDeactivated()

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

bool isDeactivated ( )

Check whether object adapter has been deactivated.

Returns: Whether adapter has been deactivated.

See also: Communicator::shutdown

◆ refreshPublishedEndpoints()

["js:async"]

void refreshPublishedEndpoints ( )

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.

◆ remove()

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

Object remove ( Identity id )

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

Parameters

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

Returns: The removed servant.

See also: Identity; add; addWithUUID

◆ removeAllFacets()

["swift:attribute:@discardableResult"]

FacetMap removeAllFacets ( Identity id )

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.

Parameters

id	The identity of the Ice object to be removed.

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

See also: remove; removeFacet

◆ removeDefaultServant()

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

Object removeDefaultServant ( string category )

Remove the default servant for a specific category.

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

Parameters

category The category of the default servant to remove.

Returns: The default servant.

See also: addDefaultServant; findDefaultServant

◆ removeFacet()

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

Object removeFacet	(	Identity	id,
		string	facet
	)

Like remove, but with a facet.

Calling remove(id) is equivalent to calling removeFacet with an empty facet.

Parameters

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

Returns: The removed servant.

See also: Identity; addFacet; addFacetWithUUID

◆ removeServantLocator()

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

ServantLocator removeServantLocator ( string category )

Remove a Servant Locator from this object adapter.

Parameters

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

Returns: The Servant Locator, or throws NotRegisteredException if no Servant Locator was found for the given category.

See also: Identity; addServantLocator; findServantLocator; ServantLocator

◆ setLocator()

void setLocator ( Locator * loc )

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.

Parameters

loc	The locator used by this object adapter.

See also: createDirectProxy; Locator; LocatorRegistry

◆ setPublishedEndpoints()

void setPublishedEndpoints ( EndpointSeq newEndpoints )

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

Parameters

newEndpoints The new set of endpoints that the object adapter will embed in proxies.

See also: refreshPublishedEndpoints; Endpoint

◆ waitForDeactivate()

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

void waitForDeactivate ( )

Wait until the object adapter has deactivated.

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

See also: deactivate; waitForHold; Communicator::waitForShutdown

◆ waitForHold()

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

void waitForHold ( )

Wait until the object adapter holds requests.

Calling hold initiates holding of requests, and waitForHold only returns when holding of requests has been completed.

See also: hold; waitForDeactivate; Communicator::waitForShutdown

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

Ice/ObjectAdapter.ice

Operations

Detailed Description

Operation Documentation

◆ activate()

◆ add()

◆ addDefaultServant()

◆ addFacet()

◆ addFacetWithUUID()

◆ addServantLocator()

◆ addWithUUID()

◆ createDirectProxy()

◆ createIndirectProxy()

◆ createProxy()

◆ deactivate()

◆ destroy()

◆ find()

◆ findAllFacets()

◆ findByProxy()

◆ findDefaultServant()

◆ findFacet()

◆ findServantLocator()

◆ getCommunicator()

◆ getEndpoints()

◆ getLocator()

◆ getName()

◆ getPublishedEndpoints()

◆ hold()

◆ isDeactivated()

◆ refreshPublishedEndpoints()

◆ remove()

◆ removeAllFacets()

◆ removeDefaultServant()

◆ removeFacet()

◆ removeServantLocator()

◆ setLocator()

◆ setPublishedEndpoints()

◆ waitForDeactivate()

◆ waitForHold()