Ice 3.7 C++11 API Reference
|
The object adapter provides an up-call interface from the Ice run time to the implementation of Ice objects. More...
#include <Ice/Ice.h>
Public Member Functions | |
virtual void | activate ()=0 |
Activate all endpoints that belong to this object adapter. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | add (const ::std::shared_ptr< Object > &servant, const Identity &id)=0 |
Add a servant to this object adapter's Active Servant Map. More... | |
virtual void | addDefaultServant (const ::std::shared_ptr< Object > &servant, const ::std::string &category)=0 |
Add a default servant to handle requests for a specific category. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | addFacet (const ::std::shared_ptr< Object > &servant, const Identity &id, const ::std::string &facet)=0 |
Like add, but with a facet. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | addFacetWithUUID (const ::std::shared_ptr< Object > &servant, const ::std::string &facet)=0 |
Like addWithUUID, but with a facet. More... | |
virtual void | addServantLocator (const ::std::shared_ptr< ServantLocator > &locator, const ::std::string &category)=0 |
Add a Servant Locator to this object adapter. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | addWithUUID (const ::std::shared_ptr< Object > &servant)=0 |
Add a servant to this object adapter's Active Servant Map, using an automatically generated UUID as its identity. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | createDirectProxy (const Identity &id) const =0 |
Create a direct proxy for the object with the given identity. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | createIndirectProxy (const Identity &id) const =0 |
Create an indirect proxy for the object with the given identity. More... | |
virtual ::std::shared_ptr<::Ice::ObjectPrx > | createProxy (const Identity &id) const =0 |
Create a proxy for the object with the given identity. More... | |
virtual void | deactivate () noexcept=0 |
Deactivate all endpoints that belong to this object adapter. More... | |
virtual void | destroy () noexcept=0 |
Destroys the object adapter and cleans up all resources held by the object adapter. More... | |
virtual ::std::shared_ptr<::Ice::Object > | find (const Identity &id) const =0 |
Look up a servant in this object adapter's Active Servant Map by the identity of the Ice object it implements. More... | |
virtual ::Ice::FacetMap | findAllFacets (const Identity &id) const =0 |
Find all facets with the given identity in the Active Servant Map. More... | |
virtual ::std::shared_ptr<::Ice::Object > | findByProxy (const ::std::shared_ptr< ObjectPrx > &proxy) const =0 |
Look up a servant in this object adapter's Active Servant Map, given a proxy. More... | |
virtual ::std::shared_ptr<::Ice::Object > | findDefaultServant (const ::std::string &category) const =0 |
Find the default servant for a specific category. More... | |
virtual ::std::shared_ptr<::Ice::Object > | findFacet (const Identity &id, const ::std::string &facet) const =0 |
Like find, but with a facet. More... | |
virtual ::std::shared_ptr<::Ice::ServantLocator > | findServantLocator (const ::std::string &category) const =0 |
Find a Servant Locator installed with this object adapter. More... | |
virtual ::std::shared_ptr<::Ice::Communicator > | getCommunicator () const noexcept=0 |
Get the communicator this object adapter belongs to. More... | |
virtual ::Ice::EndpointSeq | getEndpoints () const noexcept=0 |
Get the set of endpoints configured with this object adapter. More... | |
virtual ::std::shared_ptr<::Ice::LocatorPrx > | getLocator () const noexcept=0 |
Get the Ice locator used by this object adapter. More... | |
virtual ::std::string | getName () const noexcept=0 |
Get the name of this object adapter. More... | |
virtual ::Ice::EndpointSeq | getPublishedEndpoints () const noexcept=0 |
Get the set of endpoints that proxies created by this object adapter will contain. More... | |
virtual void | hold ()=0 |
Temporarily hold receiving and dispatching requests. More... | |
virtual bool | isDeactivated () const noexcept=0 |
Check whether object adapter has been deactivated. More... | |
virtual void | refreshPublishedEndpoints ()=0 |
Refresh the set of published endpoints. More... | |
virtual ::std::shared_ptr<::Ice::Object > | remove (const Identity &id)=0 |
Remove a servant (that is, the default facet) from the object adapter's Active Servant Map. More... | |
virtual ::Ice::FacetMap | removeAllFacets (const Identity &id)=0 |
Remove all facets with the given identity from the Active Servant Map. More... | |
virtual ::std::shared_ptr<::Ice::Object > | removeDefaultServant (const ::std::string &category)=0 |
Remove the default servant for a specific category. More... | |
virtual ::std::shared_ptr<::Ice::Object > | removeFacet (const Identity &id, const ::std::string &facet)=0 |
Like remove, but with a facet. More... | |
virtual ::std::shared_ptr<::Ice::ServantLocator > | removeServantLocator (const ::std::string &category)=0 |
Remove a Servant Locator from this object adapter. More... | |
virtual void | setLocator (const ::std::shared_ptr< LocatorPrx > &loc)=0 |
Set an Ice locator for this object adapter. More... | |
virtual void | setPublishedEndpoints (const EndpointSeq &newEndpoints)=0 |
Set of the endpoints that proxies created by this object adapter will contain. More... | |
virtual void | waitForDeactivate () noexcept=0 |
Wait until the object adapter has deactivated. More... | |
virtual void | waitForHold ()=0 |
Wait until the object adapter holds requests. More... | |
virtual | ~ObjectAdapter () |
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.
|
virtual |
|
pure virtual |
Activate all endpoints that belong to this object adapter.
After activation, the object adapter can dispatch requests received through its endpoints.
|
pure virtual |
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.
servant | The servant to add. |
id | The identity of the Ice object that is implemented by the servant. |
|
pure virtual |
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.
servant | The default servant. |
category | The category for which the default servant is registered. An empty category means it will handle all categories. |
|
pure virtual |
Like add, but with a facet.
Calling add(servant, id)
is equivalent to calling addFacet with an empty facet.
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. |
|
pure virtual |
Like addWithUUID, but with a facet.
Calling addWithUUID(servant)
is equivalent to calling addFacetWithUUID with an empty facet.
servant | The servant to add. |
facet | The facet. An empty facet means the default facet. |
|
pure virtual |
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.
|
pure virtual |
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.
servant | The servant to add. |
|
pure virtual |
Create a direct proxy for the object with the given identity.
The returned proxy contains this object adapter's published endpoints.
id | The object's identity. |
|
pure virtual |
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.
id | The object's identity. |
|
pure virtual |
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.
id | The object's identity. |
|
pure virtualnoexcept |
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.
|
pure virtualnoexcept |
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.
|
pure virtual |
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.
id | The identity of the Ice object for which the servant should be returned. |
|
pure virtual |
Find all facets with the given identity in the Active Servant Map.
id | The identity of the Ice object for which the facets should be returned. |
|
pure virtual |
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.
proxy | The proxy for which the servant should be returned. |
|
pure virtual |
Find the default servant for a specific category.
category | The category of the default servant to find. |
|
pure virtual |
Like find, but with a facet.
Calling find(id)
is equivalent to calling findFacet with an empty facet.
id | The identity of the Ice object for which the servant should be returned. |
facet | The facet. An empty facet means the default facet. |
|
pure virtual |
|
pure virtualnoexcept |
Get the communicator this object adapter belongs to.
|
pure virtualnoexcept |
Get the set of endpoints configured with this object adapter.
|
pure virtualnoexcept |
Get the Ice locator used by this object adapter.
|
pure virtualnoexcept |
Get the name of this object adapter.
|
pure virtualnoexcept |
Get the set of endpoints that proxies created by this object adapter will contain.
|
pure virtual |
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.
|
pure virtualnoexcept |
Check whether object adapter has been deactivated.
|
pure virtual |
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.
|
pure virtual |
Remove a servant (that is, the default facet) from the object adapter's Active Servant Map.
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. |
|
pure virtual |
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.
id | The identity of the Ice object to be removed. |
|
pure virtual |
Remove the default servant for a specific category.
Attempting to remove a default servant for a category that is not registered throws NotRegisteredException.
category | The category of the default servant to remove. |
|
pure virtual |
Like remove, but with a facet.
Calling remove(id)
is equivalent to calling removeFacet with an empty facet.
id | The identity of the Ice object that is implemented by the servant. |
facet | The facet. An empty facet means the default facet. |
|
pure virtual |
Remove a Servant Locator from this object adapter.
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. |
|
pure virtual |
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.
loc | The locator used by this object adapter. |
|
pure virtual |
Set of the endpoints that proxies created by this object adapter will contain.
newEndpoints | The new set of endpoints that the object adapter will embed in proxies. |
|
pure virtualnoexcept |
Wait until the object adapter has deactivated.
Calling deactivate initiates object adapter deactivation, and waitForDeactivate only returns when deactivation has been completed.
|
pure virtual |
Wait until the object adapter holds requests.
Calling hold initiates holding of requests, and waitForHold only returns when holding of requests has been completed.