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"]]
44 #ifndef __SLICE2JAVA_COMPAT__
45 [[
"java:package:com.zeroc"]]
64 [
"clr:implements:global::System.IDisposable",
"java:implements:java.lang.AutoCloseable"]
66 #if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
93 [
"cpp:noexcept",
"swift:noexcept",
"js:async"]
void destroy();
112 [
"cpp:noexcept",
"swift:noexcept",
"js:async"]
void shutdown();
144 [
"cpp:const",
"cpp:noexcept",
"swift:noexcept"]
bool isShutdown();
212 #ifndef __SLICE2SWIFT__
225 [
"cpp:const",
"deprecate:stringToIdentity() is deprecated, use the static stringToIdentity() method instead."]
311 #if !defined(__SLICE2SWIFT__)
361 [
"deprecate:addObjectFactory() is deprecated, use ValueFactoryManager::add() instead."]
379 [
"cpp:const",
"cpp:noexcept",
"deprecate:findObjectFactory() is deprecated, use ValueFactoryManager::find() instead."]
392 [
"cpp:const",
"cpp:noexcept",
"swift:noexcept",
"swift:nonnull"]
417 #if !defined(__SLICE2SWIFT__) && !defined(__SLICE2JS__)
492 #if !defined(__SLICE2SWIFT__) && !defined(__SLICE2JS__)
514 [
"cpp:const",
"cpp:noexcept",
"swift:noexcept",
"swift:nonnull"]
592 [
"swift:nonnull",
"swift:attribute:@discardableResult"]
Object removeAdminFacet(
string facet);
618 #if defined(__SLICE2SWIFT__) || defined(ICE_SWIFT)
627 [
"cpp:const",
"swift:nonnull",
"cpp:type:dispatch_queue_t",
"swift:type:Dispatch.DispatchQueue"]
628 LocalObject getClientDispatchQueue();
638 [
"cpp:const",
"swift:nonnull",
"cpp:type:dispatch_queue_t",
"swift:type:Dispatch.DispatchQueue"]
639 LocalObject getServerDispatchQueue();
The Ice router interface.
Definition: Router.ice:39
The object adapter provides an up-call interface from the Ice run time to the implementation of Ice o...
Definition: ObjectAdapter.ice:50
FacetMap
A mapping from facet name to servant.
Definition: FacetMap.ice:34
Object findAdminFacet(string facet)
Returns a facet of the Admin object.
void setDefaultLocator(Locator *loc)
Set a default Ice locator for this communicator.
The central object in Ice.
Definition: Communicator.ice:68
void shutdown()
Shuts down this communicator's server functionality, which includes the deactivation of all object ad...
@ Unicode
Characters with ordinal values greater than 127 are kept as-is in the resulting string.
Definition: Communicator.ice:658
PropertyDict proxyToProperty(["swift:nonnull"] Object *proxy, string property)
Convert a proxy to a set of proxy properties.
ObjectAdapter createObjectAdapterWithEndpoints(string name, string endpoints)
Create a new object adapter with endpoints.
void destroy()
Destroy the communicator.
dictionary< string, string > PropertyDict
A simple collection of properties, represented as a dictionary of key/value pairs.
Definition: PropertiesAdmin.ice:39
Object * propertyToProxy(string property)
Convert a set of proxy properties into a proxy.
Object * createAdmin(ObjectAdapter adminAdapter, Identity adminId)
Add the Admin object with all its facets to the provided object adapter.
ObjectAdapter createObjectAdapter(string name)
Create a new object adapter.
CompressBatch
The batch compression option when flushing queued batch requests.
Definition: Connection.ice:39
Object * getAdmin()
Get a proxy to the main facet of the Admin object.
void addObjectFactory(ObjectFactory factory, ["objc:param:sliceId"] string id)
Add an object factory to this communicator.
void waitForShutdown()
Wait until the application has called shutdown (or destroy).
An interface to associate implict contexts with communicators.
Definition: ImplicitContext.ice:58
void flushBatchRequests(CompressBatch compress)
Flush any pending batch requests for this communicator.
@ Compat
Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using octal ...
Definition: Communicator.ice:673
ObjectAdapter createObjectAdapterWithRouter(string name, ["objc:param:router", "swift:nonnull"] Router *rtr)
Create a new object adapter with a router.
ImplicitContext getImplicitContext()
Get the implicit context associated with this communicator.
string identityToString(Identity ident)
Convert an identity into a string.
The communicator observer interface used by the Ice run-time to obtain and update observers for its o...
Definition: Instrumentation.ice:385
Router * getDefaultRouter()
Get the default router this communicator.
Identity stringToIdentity(string str)
Convert a string into an identity.
Object * stringToProxy(string str)
Convert a stringified proxy into a proxy.
Instrumentation::CommunicatorObserver getObserver()
Get the observer resolver object for this communicator.
PluginManager getPluginManager()
Get the plug-in manager for this communicator.
bool isShutdown()
Check whether communicator has been shut down.
Locator * getDefaultLocator()
Get the default locator this communicator.
A property set used to configure Ice and Ice applications.
Definition: Properties.ice:42
A factory for objects.
Definition: ObjectFactory.ice:39
string proxyToString(Object *obj)
Convert a proxy into a string.
FacetMap findAllAdminFacets()
Returns a map of all facets of the Admin object.
The Ice message logger.
Definition: Logger.ice:36
The Ice core library.
Definition: BuiltinSequences.ice:27
void addAdminFacet(["swift:nonnull"] Object servant, string facet)
Add a new facet to the Admin object.
A value factory manager maintains a collection of value factories.
Definition: ValueFactory.ice:71
ToStringMode
The output mode for xxxToString method such as identityToString and proxyToString.
Definition: Communicator.ice:652
void setDefaultRouter(Router *rtr)
Set a default router for this communicator.
Logger getLogger()
Get the logger for this communicator.
ObjectFactory findObjectFactory(string id)
Find an object factory registered with this communicator.
The Ice locator interface.
Definition: Locator.ice:94
@ ASCII
Characters with ordinal values greater than 127 are encoded as universal character names in the resul...
Definition: Communicator.ice:666
The identity of an Ice object.
Definition: Identity.ice:40
ValueFactoryManager getValueFactoryManager()
Get the value factory manager for this communicator.
Properties getProperties()
Get the properties for this communicator.
Object removeAdminFacet(string facet)
Remove the following facet to the Admin object.
Each communicator has a plug-in manager to administer the set of plug-ins.
Definition: Plugin.ice:68