omero::constants

Overview

module constants

Most client-intended constants are provided in this module.

Module Index

analysis: Namespaces for analysis.
annotation: General constants used for annotations.
categories
cluster: Server-side names used for each of the services defined in API.ice.
data: Constants used for field defaults and similar in the model classes.
jobs
metadata: Namespaces for the api::IMetadata interface.
namespaces: General namespaces for StructuredAnnotations
permissions: Used by JobHandle as the status of jobs
projection: Extended restriction name which may be applied to images and other downloadable materials.
topics: Used by the IProjection methods to declare which projection to perform.

Constant Index

ACMCLIENTHEARTBEAT: Introduce in Ice 3.6.
ACMCLIENTTIMEOUT: Introduce in Ice 3.6.
ADMINSERVICE: Server-side names used for each of the services defined in API.ice.
AGENT
ANALYSISSERVICE
CLIENTTHREADPOOLSIZE: Default omero.ClientCallback.ThreadPool.Size (5).
CLIENTUUID: Key in the ImplicitContext which must be filled by all omero.client implementations.
CONFIGSERVICE
CONNECTTIMEOUT: Default Ice.Override.ConnectTimeout (5000).
CONTAINERSERVICE
DEFAULTBATCHSIZE: Determines the batch size for sending objects to the server.
DEFAULTBLOCKSIZE: Default size for byte arrays during upload and download of binary data.
DEFAULTROUTER: Default connection string for connecting to Glacier2 (Ice.Default.Router).
EVENT
EXPORTERSERVICE
GCINTERVAL: Default Ice.GC.Interval for OmeroCpp (60 seconds)
GLACIER2PORT: Default Glacier2 port.
GROUP
IP
JOBHANDLE
LDAPSERVICE
MESSAGESIZEMAX: Default Ice.MessageSizeMax (250mb).
METADATASERVICE
METADATASTORE
PASSWORD
PIXELSSERVICE
PROJECTIONSERVICE
QUERYSERVICE
RAWFILESTORE
RAWPIXELSSTORE
RENDERINGENGINE
RENDERINGSETTINGS
REPOSITORYINFO
ROISERVICE
SCRIPTSERVICE
SEARCH
SESSIONSERVICE
SESSIONUUID: Key in the ImplicitContext which must be filled by all omero.client implementations.
SHAREDRESOURCES
SHARESERVICE
THUMBNAILSTORE
TIMELINESERVICE
TYPESSERVICE
UPDATESERVICE
USERNAME

Enumeration Index

LogLevel: Log levels used by RawAccessRequest's {@code log} command for {@code path}.

Constants

const int ACMCLIENTHEARTBEAT = 2;: Introduce in Ice 3.6. Default Ice.ACM.Client.Heartbeat (2). Send a heartbeat at regular intervals when the connection is idle. To have any effect, ACMCLIENTTIMEOUT must be set to a non-zero value.

const int ACMCLIENTTIMEOUT = 60000;: Introduce in Ice 3.6. Default Ice.ACM.Client.Timeout (60000). Timeout in seconds for Active Connection Management.

const string ADMINSERVICE = "omero.api.IAdmin";: Server-side names used for each of the services defined in API.ice. These names can be used in the ServiceFactory.getByName() and createByName() methods.

const string AGENT = "omero.agent";

const string ANALYSISSERVICE = "omero.api.IAnalysis";

const int CLIENTTHREADPOOLSIZE = 5;: Default omero.ClientCallback.ThreadPool.Size (5). Must be set before communicator initialization.

const string CLIENTUUID = "omero.client.uuid";: Key in the ImplicitContext which must be filled by all omero.client implementations. Primarily used by the session manager to count references to sessions.

const string CONFIGSERVICE = "omero.api.IConfig";

const int CONNECTTIMEOUT = 5000;: Default Ice.Override.ConnectTimeout (5000). Also not strictly necessary, but prevents clients being blocked by failed servers. -1 disables.

const string CONTAINERSERVICE = "omero.api.IContainer";

const int DEFAULTBATCHSIZE = 2000;: Determines the batch size for sending objects to the server. Too many can result in MessageSizeMax errors.

const int DEFAULTBLOCKSIZE = 5000000;: Default size for byte arrays during upload and download of binary data.

const string DEFAULTROUTER = "OMERO.Glacier2/router:ssl -p @omero.port@ -h @omero.host@";: Default connection string for connecting to Glacier2 (Ice.Default.Router). The '@omero.port@' and '@omero.host@' values will be replaced by the properties with those names from the context.

const string EVENT = "omero.event";

const string EXPORTERSERVICE = "omero.api.Exporter";

const int GCINTERVAL = 60;: Default Ice.GC.Interval for OmeroCpp (60 seconds)

const int GLACIER2PORT = 4064;: Default Glacier2 port. Used to define '@omero.port@' if not set.

const string GROUP = "omero.group";

const string IP = "omero.ip";

const string JOBHANDLE = "omero.api.JobHandle";

const string LDAPSERVICE = "omero.api.ILdap";

const int MESSAGESIZEMAX = 250000;: Default Ice.MessageSizeMax (250mb). Not strictly necessary, but helps to curb memory issues. Must be set before communicator initialization. Temporarily set to 250MB

const string METADATASERVICE = "omero.api.IMetadata";

const string METADATASTORE = "omero.api.MetadataStore";

const string PASSWORD = "omero.pass";

const string PIXELSSERVICE = "omero.api.IPixels";

const string PROJECTIONSERVICE = "omero.api.IProjection";

const string QUERYSERVICE = "omero.api.IQuery";

const string RAWFILESTORE = "omero.api.RawFileStore";

const string RAWPIXELSSTORE = "omero.api.RawPixelsStore";

const string RENDERINGENGINE = "omero.api.RenderingEngine";

const string RENDERINGSETTINGS = "omero.api.IRenderingSettings";

const string REPOSITORYINFO = "omero.api.IRepositoryInfo";

const string ROISERVICE = "omero.api.IRoi";

const string SCRIPTSERVICE = "omero.api.IScript";

const string SEARCH = "omero.api.Search";

const string SESSIONSERVICE = "omero.api.ISession";

const string SESSIONUUID = "omero.session.uuid";: Key in the ImplicitContext which must be filled by all omero.client implementations. Primarily used by backend services to lookup the proper sessions for clients.

const string SHAREDRESOURCES = "omero.grid.SharedResources";

const string SHARESERVICE = "omero.api.IShare";

const string THUMBNAILSTORE = "omero.api.ThumbnailStore";

const string TIMELINESERVICE = "omero.api.ITimeline";

const string TYPESSERVICE = "omero.api.ITypes";

const string UPDATESERVICE = "omero.api.IUpdate";

const string USERNAME = "omero.user";

Home

Index