Ice 3.7 Slice API Reference
|
Go to the documentation of this file.
7 [[
"cpp:dll-export:ICE_API"]]
8 [[
"cpp:doxygen:include:Ice/Ice.h"]]
16 [[
"objc:dll-export:ICE_API"]]
17 [[
"objc:header-dir:objc"]]
19 [[
"python:pkgdir:Ice"]]
28 #ifndef __SLICE2JAVA_COMPAT__
29 [[
"java:package:com.zeroc"]]
58 [
"cpp:const",
"cpp:noexcept",
"swift:noexcept"]
string getName();
98 [
"swift:noexcept"]
void hold();
138 [
"cpp:noexcept",
"swift:noexcept",
"js:async"]
void deactivate();
179 [
"cpp:noexcept",
"swift:noexcept",
"js:async"]
void destroy();
203 [
"swift:nonnull",
"swift:attribute:@discardableResult"]
204 Object*
add([
"swift:nonnull"]
Object servant, [
"objc:param:identity"]
Identity id);
228 [
"swift:nonnull",
"swift:attribute:@discardableResult"]
229 Object*
addFacet([
"swift:nonnull"]
Object servant, [
"objc:param:identity"]
Identity id,
string facet);
250 [
"swift:nonnull",
"swift:attribute:@discardableResult"]
Object*
addWithUUID([
"swift:nonnull"]
Object servant);
273 [
"swift:nonnull",
"swift:attribute:@discardableResult"]
Object*
addFacetWithUUID([
"swift:nonnull"]
Object servant,
string facet);
333 [
"swift:nonnull",
"swift:attribute:@discardableResult"]
Object remove(
Identity id);
469 [
"swift:noexcept",
"cpp:const"]
Object findByProxy([
"swift:nonnull"]
Object* proxy);
699 #if defined(__SLICE2SWIFT__) || defined(ICE_SWIFT)
705 [
"cpp:const",
"swift:nonnull",
"cpp:type:dispatch_queue_t",
"swift:type:Dispatch.DispatchQueue"]
706 LocalObject getDispatchQueue();
Object findFacet(Identity id, string facet)
Like find, but with a facet.
void setPublishedEndpoints(EndpointSeq newEndpoints)
Set of the endpoints that proxies created by this object adapter will contain.
void hold()
Temporarily hold receiving and dispatching requests.
EndpointSeq getEndpoints()
Get the set of endpoints configured with this object adapter.
Object * addWithUUID(["swift:nonnull"] Object servant)
Add a servant to this object adapter's Active Servant Map, using an automatically generated UUID as i...
void destroy()
Destroys the object adapter and cleans up all resources held by the object adapter.
The object adapter provides an up-call interface from the Ice run time to the implementation of Ice o...
Definition: ObjectAdapter.ice:50
bool isDeactivated()
Check whether object adapter has been deactivated.
FacetMap
A mapping from facet name to servant.
Definition: FacetMap.ice:34
Object * createProxy(Identity id)
Create a proxy for the object with the given identity.
The central object in Ice.
Definition: Communicator.ice:68
ServantLocator findServantLocator(string category)
Find a Servant Locator installed with this object adapter.
Object find(Identity id)
Look up a servant in this object adapter's Active Servant Map by the identity of the Ice object it im...
Object removeFacet(Identity id, string facet)
Like remove, but with a facet.
void addServantLocator(["swift:nonnull"] ServantLocator locator, string category)
Add a Servant Locator to this object adapter.
ServantLocator removeServantLocator(string category)
Remove a Servant Locator from this object adapter.
Object findByProxy(["swift:nonnull"] Object *proxy)
Look up a servant in this object adapter's Active Servant Map, given a proxy.
string getName()
Get the name of this object adapter.
Object * add(["swift:nonnull"] Object servant, ["objc:param:identity"] Identity id)
Add a servant to this object adapter's Active Servant Map.
Object * createIndirectProxy(Identity id)
Create an indirect proxy for the object with the given identity.
void refreshPublishedEndpoints()
Refresh the set of published endpoints.
Object * addFacet(["swift:nonnull"] Object servant, ["objc:param:identity"] Identity id, string facet)
Like add, but with a facet.
void activate()
Activate all endpoints that belong to this object adapter.
Object * createDirectProxy(Identity id)
Create a direct proxy for the object with the given identity.
Object * addFacetWithUUID(["swift:nonnull"] Object servant, string facet)
Like addWithUUID, but with a facet.
local sequence< Endpoint > EndpointSeq
A sequence of endpoints.
Definition: EndpointF.ice:41
A servant locator is called by an object adapter to locate a servant that is not found in its active ...
Definition: ServantLocator.ice:43
Object findDefaultServant(string category)
Find the default servant for a specific category.
EndpointSeq getPublishedEndpoints()
Get the set of endpoints that proxies created by this object adapter will contain.
void waitForDeactivate()
Wait until the object adapter has deactivated.
void setLocator(Locator *loc)
Set an Ice locator for this object adapter.
The Ice core library.
Definition: BuiltinSequences.ice:27
Locator * getLocator()
Get the Ice locator used by this object adapter.
FacetMap removeAllFacets(Identity id)
Remove all facets with the given identity from the Active Servant Map.
Communicator getCommunicator()
Get the communicator this object adapter belongs to.
void waitForHold()
Wait until the object adapter holds requests.
void addDefaultServant(["swift:nonnull"] Object servant, string category)
Add a default servant to handle requests for a specific category.
The Ice locator interface.
Definition: Locator.ice:94
FacetMap findAllFacets(Identity id)
Find all facets with the given identity in the Active Servant Map.
The identity of an Ice object.
Definition: Identity.ice:40
Object removeDefaultServant(string category)
Remove the default servant for a specific category.
void deactivate()
Deactivate all endpoints that belong to this object adapter.