/usr/lib/python2.7/dist-packages/Ice/Communicator_ice.py is in python-zeroc-ice 3.7.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | # -*- coding: utf-8 -*-
# **********************************************************************
#
# Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
#
# This copy of Ice is licensed to you under the terms described in the
# ICE_LICENSE file included in this distribution.
#
# **********************************************************************
#
# Ice version 3.7.0
#
# <auto-generated>
#
# Generated from file `Communicator.ice'
#
# Warning: do not edit this file.
#
# </auto-generated>
#
from sys import version_info as _version_info_
import Ice, IcePy
import Ice.LoggerF_ice
import Ice.InstrumentationF_ice
import Ice.ObjectAdapterF_ice
import Ice.ObjectFactory_ice
import Ice.ValueFactory_ice
import Ice.Router_ice
import Ice.Locator_ice
import Ice.PluginF_ice
import Ice.ImplicitContextF_ice
import Ice.Current_ice
import Ice.Properties_ice
import Ice.FacetMap_ice
import Ice.Connection_ice
# Included module Ice
_M_Ice = Ice.openModule('Ice')
# Included module Ice.Instrumentation
_M_Ice.Instrumentation = Ice.openModule('Ice.Instrumentation')
# Start of module Ice
__name__ = 'Ice'
_M_Ice.__doc__ = """
The Ice core library. Among many other features, the Ice core
library manages all the communication tasks using an efficient
protocol (including protocol compression and support for both TCP
and UDP), provides a thread pool for multi-threaded servers, and
additional functionality that supports high scalability.
"""
if 'Communicator' not in _M_Ice.__dict__:
_M_Ice.Communicator = Ice.createTempClass()
class Communicator(object):
"""
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.
"""
def __init__(self):
if Ice.getType(self) == _M_Ice.Communicator:
raise RuntimeError('Ice.Communicator is an abstract class')
def destroy(self):
"""
Destroy the communicator. This operation calls shutdown
implicitly. Calling destroy cleans up memory, and shuts down
this communicator's client functionality and destroys all object
adapters. Subsequent calls to destroy are ignored.
"""
raise NotImplementedError("method 'destroy' not implemented")
def shutdown(self):
"""
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
waitForShutdown to wait for the completion of all
requests.
"""
raise NotImplementedError("method 'shutdown' not implemented")
def waitForShutdown(self):
"""
Wait until the application has called shutdown (or 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 block until another
thread has called shutdown or destroy.
A typical use of this operation is to call it
from the main thread, which then waits until some other thread
calls shutdown. After shut-down is complete, the main thread
returns and can do some cleanup work before it finally calls
destroy to shut down the client functionality, and then
exits the application.
"""
raise NotImplementedError("method 'waitForShutdown' not implemented")
def isShutdown(self):
"""
Check whether communicator has been shut down.
Returns: True if the communicator has been shut down; false otherwise.
"""
raise NotImplementedError("method 'isShutdown' not implemented")
def stringToProxy(self, str):
"""
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.
An appendix in the Ice manual provides a detailed description
of the syntax supported by stringified proxies.
Arguments:
str -- The stringified proxy to convert into a proxy.
Returns: The proxy, or nil if str is an empty string.
"""
raise NotImplementedError("method 'stringToProxy' not implemented")
def proxyToString(self, obj):
"""
Convert a proxy into a string.
Arguments:
obj -- The proxy to convert into a stringified proxy.
Returns: The stringified proxy, or an empty string if obj is nil.
"""
raise NotImplementedError("method 'proxyToString' not implemented")
def propertyToProxy(self, property):
"""
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 as
MyProxy=id:tcp -h localhost -p 10000. Additional
properties configure local settings for the proxy, such as
MyProxy.PreferSecure=1. The "Properties"
appendix in the Ice manual describes each of the supported
proxy properties.
Arguments:
property -- The base property name.
Returns: The proxy.
"""
raise NotImplementedError("method 'propertyToProxy' not implemented")
def proxyToProperty(self, proxy, property):
"""
Convert a proxy to a set of proxy properties.
Arguments:
proxy -- The proxy.
property -- The base property name.
Returns: The property set.
"""
raise NotImplementedError("method 'proxyToProperty' not implemented")
def stringToIdentity(self, str):
"""
Convert a string into an identity. If the string does not parse
correctly, the operation throws IdentityParseException.
Arguments:
str -- The string to convert into an identity.
Returns: The identity.
"""
raise NotImplementedError("method 'stringToIdentity' not implemented")
def identityToString(self, ident):
"""
Convert an identity into a string.
Arguments:
ident -- The identity to convert into a string.
Returns: The "stringified" identity.
"""
raise NotImplementedError("method 'identityToString' not implemented")
def createObjectAdapter(self, name):
"""
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.
Arguments:
name -- The object adapter name.
Returns: The new object adapter.
"""
raise NotImplementedError("method 'createObjectAdapter' not implemented")
def createObjectAdapterWithEndpoints(self, name, endpoints):
"""
Create a new object adapter with endpoints. This operation sets
the property name.Endpoints,
and then calls 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.
Arguments:
name -- The object adapter name.
endpoints -- The endpoints for the object adapter.
Returns: The new object adapter.
"""
raise NotImplementedError("method 'createObjectAdapterWithEndpoints' not implemented")
def createObjectAdapterWithRouter(self, name, rtr):
"""
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.
Arguments:
name -- The object adapter name.
rtr -- The router.
Returns: The new object adapter.
"""
raise NotImplementedError("method 'createObjectAdapterWithRouter' not implemented")
def addObjectFactory(self, factory, id):
"""
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:
The Ice run-time looks for a factory registered
specifically for the type.
If no instance has been created, the Ice run-time looks
for the default factory, which is registered with an empty type id.
If no instance has been created by any of the preceding
steps, the Ice run-time looks for a factory that may have been
statically generated by the language mapping for non-abstract classes.
Arguments:
factory -- The factory to add.
id -- The type id for which the factory can create instances, or an empty string for the default factory.
"""
raise NotImplementedError("method 'addObjectFactory' not implemented")
def findObjectFactory(self, id):
"""
Find an object factory registered with this communicator.
Arguments:
id -- The type id for which the factory can create instances, or an empty string for the default factory.
Returns: The object factory, or null if no object factory was found for the given id.
"""
raise NotImplementedError("method 'findObjectFactory' not implemented")
def getImplicitContext(self):
"""
Get the implicit context associated with this communicator.
Returns: The implicit context associated with this communicator; returns null when the property Ice.ImplicitContext is not set or is set to None.
"""
raise NotImplementedError("method 'getImplicitContext' not implemented")
def getProperties(self):
"""
Get the properties for this communicator.
Returns: This communicator's properties.
"""
raise NotImplementedError("method 'getProperties' not implemented")
def getLogger(self):
"""
Get the logger for this communicator.
Returns: This communicator's logger.
"""
raise NotImplementedError("method 'getLogger' not implemented")
def getObserver(self):
"""
Get the observer resolver object for this communicator.
Returns: This communicator's observer resolver object.
"""
raise NotImplementedError("method 'getObserver' not implemented")
def getDefaultRouter(self):
"""
Get the default router this communicator.
Returns: The default router for this communicator.
"""
raise NotImplementedError("method 'getDefaultRouter' not implemented")
def setDefaultRouter(self, rtr):
"""
Set a default router for this communicator. All newly
created proxies will use this default router. To disable the
default router, null can be used. Note that this
operation has no effect on existing proxies.
You can also set a router for an individual proxy
by calling the operation ice_router on the proxy.
Arguments:
rtr -- The default router to use for this communicator.
"""
raise NotImplementedError("method 'setDefaultRouter' not implemented")
def getDefaultLocator(self):
"""
Get the default locator this communicator.
Returns: The default locator for this communicator.
"""
raise NotImplementedError("method 'getDefaultLocator' not implemented")
def setDefaultLocator(self, loc):
"""
Set a default Ice locator for this communicator. All newly
created proxy and object adapters will use this default
locator. To disable the default locator, null can be used.
Note that this operation has no effect on existing proxies or
object adapters.
You can also set a locator for an individual proxy
by calling the operation ice_locator on the proxy, or for an
object adapter by calling the operation ObjectAdapter#setLocator
on the object adapter.
Arguments:
loc -- The default locator to use for this communicator.
"""
raise NotImplementedError("method 'setDefaultLocator' not implemented")
def getPluginManager(self):
"""
Get the plug-in manager for this communicator.
Returns: This communicator's plug-in manager.
"""
raise NotImplementedError("method 'getPluginManager' not implemented")
def getValueFactoryManager(self):
"""
Get the value factory manager for this communicator.
Returns: This communicator's value factory manager.
"""
raise NotImplementedError("method 'getValueFactoryManager' not implemented")
def flushBatchRequests(self, compress):
"""
Flush any pending batch requests for this communicator.
This means all batch requests invoked on fixed proxies
for all connections associated with the communicator.
Any errors that occur while flushing a connection are ignored.
Arguments:
compress -- Specifies whether or not the queued batch requests should be compressed before being sent over the wire.
"""
raise NotImplementedError("method 'flushBatchRequests' not implemented")
def createAdmin(self, adminAdapter, adminId):
"""
Add the Admin object with all its facets to the provided object adapter.
If Ice.Admin.ServerId is set and the provided object adapter has a Locator,
createAdmin registers the Admin's Process facet with the Locator's LocatorRegistry.
createAdmin call only be called once; subsequent calls raise InitializationException.
Arguments:
adminAdapter -- The object adapter used to host the Admin object; if null and Ice.Admin.Endpoints is set, create, activate and use the Ice.Admin object adapter.
adminId -- The identity of the Admin object.
Returns: A proxy to the main ("") facet of the Admin object. Never returns a null proxy.
"""
raise NotImplementedError("method 'createAdmin' not implemented")
def getAdmin(self):
"""
Get a proxy to the main facet of the Admin object.
getAdmin also creates the Admin object and creates and activates the Ice.Admin object
adapter to host this Admin object if Ice.Admin.Enpoints is set. The identity of the Admin
object created by getAdmin is {value of Ice.Admin.InstanceName}/admin, or {UUID}/admin
when Ice.Admin.InstanceName is not set.
If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator
initialization, after initialization of all plugins.
Returns: A proxy to the main ("") facet of the Admin object, or a null proxy if no Admin object is configured.
"""
raise NotImplementedError("method 'getAdmin' not implemented")
def addAdminFacet(self, servant, facet):
"""
Add a new facet to the Admin object.
Adding a servant with a facet that is already registered
throws AlreadyRegisteredException.
Arguments:
servant -- The servant that implements the new Admin facet.
facet -- The name of the new Admin facet.
"""
raise NotImplementedError("method 'addAdminFacet' not implemented")
def removeAdminFacet(self, facet):
"""
Remove the following facet to the Admin object.
Removing a facet that was not previously registered throws
NotRegisteredException.
Arguments:
facet -- The name of the Admin facet.
Returns: The servant associated with this Admin facet.
"""
raise NotImplementedError("method 'removeAdminFacet' not implemented")
def findAdminFacet(self, facet):
"""
Returns a facet of the Admin object.
Arguments:
facet -- The name of the Admin facet.
Returns: The servant associated with this Admin facet, or null if no facet is registered with the given name.
"""
raise NotImplementedError("method 'findAdminFacet' not implemented")
def findAllAdminFacets(self):
"""
Returns a map of all facets of the Admin object.
Returns: A collection containing all the facet names and servants of the Admin object.
"""
raise NotImplementedError("method 'findAllAdminFacets' not implemented")
def __str__(self):
return IcePy.stringify(self, _M_Ice._t_Communicator)
__repr__ = __str__
_M_Ice._t_Communicator = IcePy.defineValue('::Ice::Communicator', Communicator, -1, (), False, True, None, ())
Communicator._ice_type = _M_Ice._t_Communicator
_M_Ice.Communicator = Communicator
del Communicator
if 'ToStringMode' not in _M_Ice.__dict__:
_M_Ice.ToStringMode = Ice.createTempClass()
class ToStringMode(Ice.EnumBase):
"""
The output mode for xxxToString method such as identityToString and proxyToString.
The actual encoding format for the string is the same for all modes: you
don't need to specify an encoding format or mode when reading such a string.
Enumerators:
Unicode -- Characters with ordinal values greater than 127 are kept as-is in the resulting string.
Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
or \\unnnn.
ASCII -- Characters with ordinal values greater than 127 are encoded as universal character names in
the resulting string: \\unnnn for BMP characters and \\Unnnnnnnn for non-BMP characters.
Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
or \\unnnn.
Compat -- Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using
octal escapes. Characters with ordinal values 127 and below are encoded as \\t, \\n (etc.) or
an octal escape. Use this mode to generate strings compatible with Ice 3.6 and earlier.
"""
def __init__(self, _n, _v):
Ice.EnumBase.__init__(self, _n, _v)
def valueOf(self, _n):
if _n in self._enumerators:
return self._enumerators[_n]
return None
valueOf = classmethod(valueOf)
ToStringMode.Unicode = ToStringMode("Unicode", 0)
ToStringMode.ASCII = ToStringMode("ASCII", 1)
ToStringMode.Compat = ToStringMode("Compat", 2)
ToStringMode._enumerators = { 0:ToStringMode.Unicode, 1:ToStringMode.ASCII, 2:ToStringMode.Compat }
_M_Ice._t_ToStringMode = IcePy.defineEnum('::Ice::ToStringMode', ToStringMode, (), ToStringMode._enumerators)
_M_Ice.ToStringMode = ToStringMode
del ToStringMode
# End of module Ice
|