Communicator class abstract
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 Logger @see ObjectAdapter @see Properties @see ValueFactory
- Implementers
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createObjectAdapter(
String name) → ObjectAdapter -
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. @param name The object adapter name. @return The new object adapter. @see #createObjectAdapterWithEndpoints @see ObjectAdapter @see Properties -
destroy(
) → void - Destroy the communicator. This Java-only method overrides close in java.lang.AutoCloseable and does not throw any exception. @see #destroy Destroy the communicator. This operation calls {@link #shutdown} implicitly. Calling {@link #destroy} cleans up memory, and shuts down this communicator's client functionality and destroys all object adapters. Subsequent calls to {@link #destroy} are ignored. @see #shutdown @see ObjectAdapter#destroy
-
getProperties(
) → Properties -
Create a new object adapter with endpoints. This operation sets
the property
name.Endpoints
, and then calls {@link #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. @param name The object adapter name. @param endpoints The endpoints for the object adapter. @return The new object adapter. @see #createObjectAdapter @see ObjectAdapter @see Properties 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. @param name The object adapter name. @param rtr The router. @return The new object adapter. @see #createObjectAdapter @see ObjectAdapter @see Properties 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: -
identityToString(
Identity ident) → String - Convert an identity into a string. @param ident The identity to convert into a string. @return The "stringified" identity. @see #stringToIdentity
-
isShutdown(
) → bool - Check whether communicator has been shut down. @return True if the communicator has been shut down; false otherwise. @see #shutdown
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
propertyToProxy(
String property) → ObjectPrx? -
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 asMyProxy=id:tcp -h localhost -p 10000
. Additional properties configure local settings for the proxy, such asMyProxy.PreferSecure=1
. The "Properties" appendix in the Ice manual describes each of the supported proxy properties. @param property The base property name. @return The proxy. -
proxyToProperty(
Object proxy, String property) → PropertyDict - Convert a proxy to a set of proxy properties. @param proxy The proxy. @param property The base property name. @return The property set.
-
proxyToString(
ObjectPrx obj) → String -
Convert a proxy into a string.
@param obj The proxy to convert into a stringified proxy.
@return The stringified proxy, or an empty string if
obj
is nil. @see #stringToProxy -
shutdown(
) → void - 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 {@link #waitForShutdown} to wait for the completion of all requests. @see #destroy @see #waitForShutdown @see ObjectAdapter#deactivate
-
stringToIdentity(
String str) → Identity - Convert a string into an identity. If the string does not parse correctly, the operation throws IdentityParseException. @param str The string to convert into an identity. @return The identity. @see #identityToString
-
stringToProxy(
String str) → ObjectPrx? -
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. @param str The stringified proxy to convert into a proxy. @return The proxy, or nil ifstr
is an empty string. @see #proxyToString -
toString(
) → String -
A string representation of this object.
inherited
-
waitForShutdown(
) → Future< void> - Wait until the application has called {@link #shutdown} (or {@link #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 {@link #shutdown} or {@link #destroy}. A typical use of this operation is to call it from the main thread, which then waits until some other thread calls {@link #shutdown}. After shut-down is complete, the main thread returns and can do some cleanup work before it finally calls {@link #destroy} to shut down the client functionality, and then exits the application. @see #shutdown @see #destroy @see ObjectAdapter#waitForDeactivate
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited