Ice Reference Manual

ZeroC, Inc.

North Palm Beach
Florida
USA


Table of Contents
Slice Documentation
Global Module
Module Index
Ice
Overview
BoolSeq
ByteSeq
DoubleSeq
FloatSeq
IdentitySeq
IntSeq
LongSeq
ObjectProxySeq
ObjectSeq
ShortSeq
StringSeq
Context
FacetMap
ObjectDict
PropertyDict
SliceChecksumDict
Ice::AbortBatchRequestException
Overview
Ice::AdapterAlreadyActiveException
Overview
Ice::AdapterNotFoundException
Overview
Ice::AlreadyRegisteredException
Overview
id
kindOfObject
Ice::BadMagicException
Overview
badMagic
Ice::CloseConnectionException
Overview
Ice::CloseTimeoutException
Overview
Ice::CollocationOptimizationException
Overview
Ice::Communicator
Overview
addObjectFactory
createObjectAdapter
createObjectAdapterWithEndpoints
destroy
findObjectFactory
flushBatchRequests
getDefaultLocator
getDefaultRouter
getLogger
getPluginManager
getProperties
getStats
proxyToString
removeObjectFactory
setDefaultLocator
setDefaultRouter
setLogger
setStats
shutdown
stringToProxy
waitForShutdown
Ice::CommunicatorDestroyedException
Overview
Ice::CompressionException
Overview
reason
Ice::CompressionNotSupportedException
Overview
Ice::ConnectFailedException
Overview
Ice::ConnectTimeoutException
Overview
Ice::Connection
Overview
close
createProxy
flushBatchRequests
timeout
toString
type
Ice::ConnectionLostException
Overview
Ice::ConnectionNotValidatedException
Overview
Ice::ConnectionRefusedException
Overview
Ice::ConnectionTimeoutException
Overview
Ice::Current
Overview
adapter
con
ctx
facet
id
mode
operation
Ice::DNSException
Overview
error
host
Ice::DatagramLimitException
Overview
Ice::EncapsulationException
Overview
Ice::EndpointParseException
Overview
str
Ice::FacetNotExistException
Overview
Ice::ForcedCloseConnectionException
Overview
Ice::Identity
Overview
category
name
Ice::IdentityParseException
Overview
str
Ice::IllegalIdentityException
Overview
id
Ice::IllegalIndirectionException
Overview
Ice::IllegalMessageSizeException
Overview
Ice::Locator
Overview
findAdapterById
findObjectById
getRegistry
Ice::LocatorRegistry
Overview
setAdapterDirectProxy
setServerProcessProxy
Ice::Logger
Overview
error
trace
warning
Ice::MarshalException
Overview
reason
Ice::MemoryLimitException
Overview
Ice::NegativeSizeException
Overview
Ice::NoEndpointException
Overview
proxy
Ice::NoObjectFactoryException
Overview
type
Ice::NotRegisteredException
Overview
id
kindOfObject
Ice::ObjectAdapter
Overview
activate
add
addFacet
addFacetWithUUID
addRouter
addServantLocator
addWithUUID
createDirectProxy
createProxy
createReverseProxy
deactivate
find
findAllFacets
findByProxy
findFacet
findServantLocator
getCommunicator
getName
hold
remove
removeAllFacets
removeFacet
setLocator
waitForDeactivate
waitForHold
Ice::ObjectAdapterDeactivatedException
Overview
name
Ice::ObjectAdapterIdInUseException
Overview
id
Ice::ObjectFactory
Overview
create
destroy
Ice::ObjectNotExistException
Overview
Ice::ObjectNotFoundException
Overview
Ice::OperationMode
Overview
Normal
Nonmutating
Idempotent
Ice::OperationNotExistException
Overview
Ice::Plugin
Overview
destroy
Ice::PluginInitializationException
Overview
reason
Ice::PluginManager
Overview
addPlugin
destroy
getPlugin
Ice::Process
Overview
shutdown
writeMessage
Ice::Properties
Overview
clone
getCommandLineOptions
getPropertiesForPrefix
getProperty
getPropertyAsInt
getPropertyAsIntWithDefault
getPropertyWithDefault
load
parseCommandLineOptions
parseIceCommandLineOptions
setProperty
Ice::ProtocolException
Overview
Ice::ProxyParseException
Overview
str
Ice::ProxyUnmarshalException
Overview
Ice::RequestFailedException
Overview
facet
id
operation
Ice::Router
Overview
addProxy
getClientProxy
getServerProxy
Ice::ServantLocator
Overview
deactivate
finished
locate
Ice::ServerNotFoundException
Overview
Ice::SocketException
Overview
Ice::Stats
Overview
bytesReceived
bytesSent
Ice::SyscallException
Overview
error
Ice::TimeoutException
Overview
Ice::TwowayOnlyException
Overview
operation
Ice::UnknownException
Overview
unknown
Ice::UnknownLocalException
Overview
Ice::UnknownMessageException
Overview
Ice::UnknownReplyStatusException
Overview
Ice::UnknownRequestIdException
Overview
Ice::UnknownUserException
Overview
Ice::UnmarshalOutOfBoundsException
Overview
Ice::UnsupportedEncodingException
Overview
badMajor
badMinor
major
minor
Ice::UnsupportedProtocolException
Overview
badMajor
badMinor
major
minor
Ice::VersionMismatchException
Overview
Freeze
Overview
Key
Value
Freeze::Connection
Overview
beginTransaction
close
currentTransaction
getCommunicator
getName
Freeze::DatabaseException
Overview
message
Freeze::DeadlockException
Overview
Freeze::Evictor
Overview
add
addFacet
createObject
destroyObject
getIterator
getSize
hasFacet
hasObject
keep
keepFacet
release
releaseFacet
remove
removeFacet
setSize
Freeze::EvictorDeactivatedException
Overview
Freeze::EvictorIterator
Overview
hasNext
next
Freeze::InvalidPositionException
Overview
Freeze::NoSuchElementException
Overview
Freeze::NotFoundException
Overview
Freeze::ObjectRecord
Overview
servant
stats
Freeze::ServantInitializer
Overview
initialize
Freeze::Statistics
Overview
avgSaveTime
creationTime
lastSaveTime
Freeze::Transaction
Overview
commit
rollback
Freeze::TransactionAlreadyInProgressException
Overview
IceBox
Overview
IceBox::FailureException
Overview
reason
IceBox::Service
Overview
start
stop
IceBox::ServiceManager
Overview
getSliceChecksums
shutdown
IcePack
Overview
AdapterDescriptorSeq
DbEnvDescriptorSeq
ObjectDescriptorSeq
PropertyDescriptorSeq
ServerDescriptorSeq
ServiceDescriptorSeq
IcePack::AdapterDescriptor
Overview
endpoints
id
name
objects
registerProcess
IcePack::AdapterNotExistException
Overview
IcePack::Admin
Overview
addApplication
addObject
addObjectWithType
addServer
getAdapterEndpoints
getAllAdapterIds
getAllApplicationNames
getAllNodeNames
getAllServerNames
getApplicationDescriptor
getServerActivation
getServerDescriptor
getServerPid
getServerState
getSliceChecksums
pingNode
removeApplication
removeNode
removeObject
removeServer
sendSignal
setServerActivation
shutdown
shutdownNode
startServer
stopServer
updateApplication
updateServer
writeMessage
IcePack::ApplicationDescriptor
Overview
comment
name
servers
IcePack::ApplicationNotExistException
Overview
IcePack::BadSignalException
Overview
IcePack::ComponentDescriptor
Overview
adapters
comment
dbEnvs
name
properties
IcePack::CppIceBoxDescriptor
Overview
endpoints
services
IcePack::DbEnvDescriptor
Overview
dbHome
name
properties
IcePack::DeploymentException
Overview
reason
IcePack::JavaIceBoxDescriptor
Overview
endpoints
services
IcePack::JavaServerDescriptor
Overview
className
jvmOptions
IcePack::NodeNotExistException
Overview
IcePack::NodeUnreachableException
Overview
IcePack::ObjectDescriptor
Overview
adapterId
proxy
type
IcePack::ObjectExistsException
Overview
IcePack::ObjectNotExistException
Overview
IcePack::PropertyDescriptor
Overview
name
value
IcePack::Query
Overview
findAllObjectsWithType
findObjectById
findObjectByType
IcePack::ServerActivation
Overview
OnDemand
Manual
IcePack::ServerDescriptor
Overview
activation
application
envs
exe
node
options
pwd
IcePack::ServerNotExistException
Overview
IcePack::ServerState
Overview
Inactive
Activating
Active
Deactivating
Destroying
Destroyed
IcePack::ServiceDescriptor
Overview
entry
IceSSL
Overview
IceSSL::CertificateException
Overview
IceSSL::CertificateKeyMatchException
Overview
IceSSL::CertificateLoadException
Overview
IceSSL::CertificateParseException
Overview
IceSSL::CertificateSignatureException
Overview
IceSSL::CertificateSigningException
Overview
IceSSL::CertificateVerificationException
Overview
IceSSL::CertificateVerifier
Overview
setContext
IceSSL::CertificateVerifierTypeException
Overview
IceSSL::ConfigParseException
Overview
IceSSL::ConfigurationLoadingException
Overview
IceSSL::ContextException
Overview
IceSSL::ContextInitializationException
Overview
IceSSL::ContextNotConfiguredException
Overview
IceSSL::ContextType
Overview
Client
Server
ClientServer
IceSSL::Plugin
Overview
addTrustedCertificate
addTrustedCertificateBase64
configure
getDefaultCertVerifier
getSingleCertVerifier
loadConfig
setCertificateVerifier
setRSAKeys
setRSAKeysBase64
IceSSL::PrivateKeyException
Overview
IceSSL::PrivateKeyLoadException
Overview
IceSSL::PrivateKeyParseException
Overview
IceSSL::ProtocolException
Overview
IceSSL::ShutdownException
Overview
IceSSL::SslException
Overview
message
IceSSL::TrustedCertificateAddException
Overview
IceSSL::UnsupportedContextException
Overview
Glacier
Overview
Glacier::CannotStartRouterException
Overview
reason
Glacier::NoSessionManagerException
Overview
Glacier::PermissionDeniedException
Overview
reason
Glacier::PermissionsVerifier
Overview
checkPermissions
Glacier::Router
Overview
createSession
shutdown
Glacier::Session
Overview
destroy
Glacier::SessionManager
Overview
create
Glacier::Starter
Overview
getSliceChecksums
startRouter
IceStorm
Overview
LinkInfoSeq
QoS
TopicDict
IceStorm::LinkExists
Overview
name
IceStorm::LinkInfo
Overview
cost
name
theTopic
IceStorm::NoSuchLink
Overview
name
IceStorm::NoSuchTopic
Overview
name
IceStorm::Topic
Overview
destroy
getLinkInfoSeq
getName
getPublisher
link
subscribe
unlink
unsubscribe
IceStorm::TopicExists
Overview
name
IceStorm::TopicManager
Overview
create
getSliceChecksums
retrieve
retrieveAll
IcePatch
Overview
FileDescSeq
IcePatch::BusyException
Overview
IcePatch::Directory
Overview
getContents
getTotal
IcePatch::DirectoryDesc
Overview
dir
IcePatch::File
Overview
describe
getSliceChecksums
IcePatch::FileAccessException
Overview
reason
IcePatch::FileDesc
Overview
md5
IcePatch::Regular
Overview
getBZ2
getBZ2MD5
getBZ2Size
IcePatch::RegularDesc
Overview
reg
Properties
Ice Configuration Property
Ice.Config
Ice Trace Properties
Ice.Trace.GC
Ice.Trace.Network
Ice.Trace.Protocol
Ice.Trace.Retry
Ice.Trace.Slicing
Ice Warning Properties
Ice.Warn.Connections
Ice.Warn.Datagrams
Ice.Warn.Dispatch
Ice.Warn.AMICallback
Ice.Warn.Leaks
Ice Object Adapter Properties
name.AdapterId
name.Endpoints
name.PublishedEndpoints
name.Locator
name.RegisterProcess
name.Router
Ice.PrintAdapterReady
Ice Plug-in Properties
Ice.Plugin.name
Ice Thread Pool Properties
name.Size
name.SizeMax
name.SizeWarn
name.StackSize
Ice Default and Override Properties
Ice.Default.Protocol
Ice.Default.Host
Ice.Default.Router
Ice.Default.Locator
Ice.Override.Timeout
Ice.Override.ConnectTimeout
Ice.Override.Compress
Ice Miscellaneous Properties
Ice.GC.Interval
Ice.RetryIntervals
Ice.MessageSizeMax
Ice.ChangeUser
Ice.ConnectionIdleTime
Ice.MonitorConnections
Ice.PrintProcessId
Ice.ProgramName
Ice.ServerId
Ice.ServerIdleTime
Ice.StdErr
Ice.StdOut
Ice.UseEventLog
Ice.UseSyslog
Ice.Logger.Timestamp
Ice.NullHandleAbort
Ice.Nohup
Ice.UDP.RcvSize, Ice.UDP.SndSize
Ice.Package.module
Ice.Default.Package
IceSSL Properties
IceSSL.Trace.Security
IceSSL.Client.CertPath, IceSSL.Server.CertPath
IceSSL.Client.Config, IceSSL.Server.Config
IceSSL.Client.Handshake.Retries
IceSSL.Client.Passphrase.Retries, IceSSL.Server.Passphrase.Retries
IceSSL.Server.Overrides.RSA.PrivateKey, IceSSL.Server.Overrides.RSA.Certificate
IceSSL.Server.Overrides.DSA.PrivateKey, IceSSL.Server.Overrides.DSA.Certificate
IceSSL.Client.Overrides.RSA.PrivateKey, IceSSL.Client.Overrides.RSA.Certificate
IceSSL.Client.Overrides.DSA.PrivateKey, IceSSL.Client.Overrides.DSA.Certificate
IceSSL.Client.Overrides.CACertificate, IceSSL.Server.Overrides.CACertificate
IceSSL.Client.IgnoreValidPeriod, IceSSL.Server.IgnoreValidPeriod
IceBox Properties
IceBox.ServiceManager.AdapterId
IceBox.ServiceManager.Endpoints
IceBox.ServiceManager.PublishedEndpoints
IceBox.ServiceManager.Identity
IceBox.ServiceManager.RegisterProcess
IceBox.ServiceManager.ThreadPool.Size
IceBox.ServiceManager.ThreadPool.SizeMax
IceBox.ServiceManager.ThreadPool.SizeWarn
IceBox.LoadOrder
IceBox.PrintServicesReady
IceBox.Service.name
IceBox.UseSharedCommunicator.name
IcePack Properties
IcePack.Registry.Client.AdapterId
IcePack.Registry.Client.Endpoints
IcePack.Registry.Client.PublishedEndpoints
IcePack.Registry.Client.ThreadPool.Size
IcePack.Registry.Client.ThreadPool.SizeMax
IcePack.Registry.Client.ThreadPool.SizeWarn
IcePack.Registry.Server.AdapterId
IcePack.Registry.Server.Endpoints
IcePack.Registry.Server.PublishedEndpoints
IcePack.Registry.Server.ThreadPool.Size
IcePack.Registry.Server.ThreadPool.SizeMax
IcePack.Registry.Server.ThreadPool.SizeWarn
IcePack.Registry.Admin.AdapterId
IcePack.Registry.Admin.Endpoints
IcePack.Registry.Admin.PublishedEndpoints
IcePack.Registry.Admin.ThreadPool.Size
IcePack.Registry.Admin.ThreadPool.SizeMax
IcePack.Registry.Admin.ThreadPool.SizeWarn
IcePack.Registry.Internal.AdapterId
IcePack.Registry.Internal.Endpoints
IcePack.Registry.Internal.PublishedEndpoints
IcePack.Registry.Internal.ThreadPool.Size
IcePack.Registry.Internal.ThreadPool.SizeMax
IcePack.Registry.Internal.ThreadPool.SizeWarn
IcePack.Registry.Data
IcePack.Registry.DynamicRegistration
IcePack.Registry.Trace.ServerRegistry
IcePack.Registry.Trace.AdapterRegistry
IcePack.Registry.Trace.NodeRegistry
IcePack.Registry.Trace.ObjectRegistry
IcePack.Node.AdapterId
IcePack.Node.Endpoints
IcePack.Node.PublishedEndpoints
IcePack.Node.AdapterId
IcePack.Node.Name
IcePack.Node.Data
IcePack.Node.Output
IcePack.Node.PropertiesOverride
IcePack.Node.RedirectErrToOut
IcePack.Node.WaitTime
IcePack.Node.CollocateRegistry
IcePack.Node.PrintServersReady
IcePack.Node.ThreadPool.Size
IcePack.Node.ThreadPool.SizeMax
IcePack.Node.ThreadPool.SizeWarn
IcePack.Node.Trace.Server
IcePack.Node.Trace.Adapter
IcePack.Node.Trace.Activator
IceStorm Properties
IceStorm.TopicManager.AdapterId
IceStorm.TopicManager.Endpoints
IceStorm.TopicManager.PublishedEndpoints
IceStorm.TopicManager.RegisterProcess
IceStorm.TopicManager.ThreadPool.Size
IceStorm.TopicManager.ThreadPool.SizeMax
IceStorm.TopicManager.ThreadPool.SizeWarn
IceStorm.Publish.AdapterId
IceStorm.Publish.Endpoints
IceStorm.Publish.PublishedEndpoints
IceStorm.Publish.RegisterProcess
IceStorm.Publish.ThreadPool.Size
IceStorm.Publish.ThreadPool.SizeMax
IceStorm.Publish.ThreadPool.SizeWarn
IceStorm.Trace.TopicManager
IceStorm.Trace.Topic
IceStorm.Trace.Flush
IceStorm.Trace.Subscriber
IceStorm.Flush.Timeout
IceStorm.TopicManager.Proxy
Glacier Router Properties
Glacier.Router.AdapterId, Glacier.Router.Client.AdapterId, Glacier.Router.Server.AdapterId
Glacier.Router.Endpoints, Glacier.Router.Client.Endpoints, Glacier.Router.Server.Endpoints
Glacier.Router.PublishedEndpoints, Glacier.Router.Client.PublishedEndpoints, Glacier.Router.Server.PublishedEndpoints
Glacier.Router.Identity
Glacier.Router.PrintProxyOnFd
Glacier.Router.Trace.Client
Glacier.Router.Trace.Server
Glacier.Router.Trace.RoutingTable
Glacier.Router.Trace.Throttle
Glacier.Router.Client.ForwardContext, Glacier.Router.Server.ForwardContext
Glacier.Router.Client.SleepTime, Glacier.Router.Server.SleepTime
Glacier.Router.Client.Throttle.Twoways, Glacier.Router.Server.Throttle.Twoways
Glacier.Router.SessionManager
Glacier.Router.UserId
Glacier.Router.AllowCategories
Glacier.Router.AcceptCert
Glacier.Router.ThreadPool.Size
Glacier.Router.ThreadPool.SizeMax
Glacier.Router.ThreadPool.SizeWarn
Glacier.Router.Client.ThreadPool.Size
Glacier.Router.Client.ThreadPool.SizeMax
Glacier.Router.Client.ThreadPool.SizeWarn
Glacier.Router.Server.ThreadPool.Size
Glacier.Router.Server.ThreadPool.SizeMax
Glacier.Router.Server.ThreadPool.SizeWarn
Glacier Router Starter Properties
Glacier.Starter.AdapterId
Glacier.Starter.Endpoints
Glacier.Starter.PublishedEndpoints
Glacier.Starter.ThreadPool.Size
Glacier.Starter.ThreadPool.SizeMax
Glacier.Starter.ThreadPool.SizeWarn
Glacier.Starter.PermissionsVerifier
Glacier.Starter.CryptPasswords
Glacier.Starter.RouterPath
Glacier.Starter.PropertiesOverride
Glacier.Starter.StartupTimeout
Glacier.Starter.AddUserToAllowCategories
Glacier.Starter.Trace
Glacier.Starter.Certificate.Country
Glacier.Starter.Certificate.StateProvince
Glacier.Starter.Certificate.Locality
Glacier.Starter.Certificate.Organization
Glacier.Starter.Certificate.OrganizationalUnit
Glacier.Starter.Certificate.CommonName
Glacier.Starter.Certificate.BitStrength
Glacier.Starter.Certificate.SecondsValid
Glacier.Starter.Certificate.IssuedAdjust
Freeze Properties
Freeze.DbEnv.env-name.DbCheckpointPeriod
Freeze.DbEnv.env-name.DbHome
Freeze.DbEnv.env-name.DbPrivate
Freeze.DbEnv.env-name.DbRecoverFatal
Freeze.DbEnv.env-name.OldLogsAutoDelete
Freeze.DbEnv.env-name.PeriodicCheckpointMinSize
Freeze.Evictor.env-name.filename.MaxTxSize
Freeze.Evictor.env-name.filename.SavePeriod
Freeze.Evictor.env-name.filename.SaveSizeTrigger
Freeze.Evictor.env-name.filename.StreamTimeout
Freeze.Trace.DbEnv
Freeze.Trace.Evictor
Freeze.Trace.Map
Freeze.Warn.Deadlocks
Freeze.Warn.CloseInFinalize
IcePatch Properties
IcePatch.Endpoints
IcePatch.PublishedEndpoints
IcePatch.Directory
IcePatch.UpdatePeriod
IcePatch.BusyTimeout
IcePatch.Trace.Files
IcePatch.RemoveOrphaned
IcePatch.Thorough
IcePatch.Dynamic
Glacier2 Properties
Glacier2.AddUserToAllowCategories
Glacier2.Admin.Endpoints
Glacier2.Admin.PublishedEndpoints
Glacier2.AdminIdentity
Glacier2.AllowCategories
Glacier2.Client.AlwaysBatch
Glacier2.Client.Endpoints
Glacier2.Client.PublishedEndpoints
Glacier2.Client.ForwardContext
Glacier2.Client.SleepTime
Glacier2.Client.Trace.Override
Glacier2.Client.Trace.Reject
Glacier2.Client.Trace.Request
Glacier2.Client.Buffered
Glacier2.CryptPasswords
Glacier2.PermissionsVerifier
Glacier2.RouterIdentity
Glacier2.Server.AlwaysBatch
Glacier2.Server.Endpoints
Glacier2.Server.PublishedEndpoints
Glacier2.Server.ForwardContext
Glacier2.Server.SleepTime
Glacier2.Server.Trace.Override
Glacier2.Server.Trace.Reject
Glacier2.Server.Trace.Request
Glacier2.Server.Buffered
Glacier2.SessionManager
Glacier2.SessionTimeout
Glacier2.Trace.RoutingTable
Glacier2.Trace.Session
Proxies and Endpoints
Proxies
Synopsis
Description
Endpoints
Synopsis
Description
TCP Endpoint
UDP Endpoint
SSL Endpoint