File: x3097.html

package info (click to toggle)
zeroc-ice-csharp 3.1.1-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 7,528 kB
ctags: 4,781
sloc: cs: 43,696; python: 1,087; makefile: 1,071; xml: 115; ansic: 47; sh: 2
file content (738 lines) | stat: -rw-r--r-- 9,291 bytes
parent folder | download | duplicates (4)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Ice::LocatorRegistry</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Ice Reference Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Slice Documentation"
HREF="c13.html"><LINK
REL="PREVIOUS"
TITLE="Ice::Locator"
HREF="x2989.html"><LINK
REL="NEXT"
TITLE="Ice::Logger"
HREF="x3266.html"></HEAD
><BODY
CLASS="SECTION"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Ice Reference Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="x2989.html"
ACCESSKEY="P"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Slice Documentation</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x3266.html"
ACCESSKEY="N"
>Next &#62;&#62;&#62;</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="ICE.LOCATORREGISTRY"
><TT
CLASS="LITERAL"
>Ice::LocatorRegistry</TT
></A
></H1
><DIV
CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN3100"
>Overview</A
></H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>interface <CODE
CLASS="CLASSNAME"
>LocatorRegistry</CODE
></PRE
></TD
></TR
></TABLE
><P
>The <SPAN
CLASS="phrase"
><SPAN
CLASS="PHRASE"
>Ice</SPAN
></SPAN
> locator registry interface. This interface is used by
servers to register adapter endpoints with the locator.
<DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
> The <A
HREF="x3097.html"
><CODE
CLASS="CLASSNAME"
>LocatorRegistry</CODE
></A
> interface is intended to be used
by <SPAN
CLASS="phrase"
><SPAN
CLASS="PHRASE"
>Ice</SPAN
></SPAN
> internals and by locator implementations. Regular user
code should not attempt to use any functionality of this interface
directly.</P
></TD
></TR
></TABLE
></DIV
></P
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN3111"
>Operation Index</A
></H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><A
HREF="x3097.html#ICE.LOCATORREGISTRY.SETADAPTERDIRECTPROXY"
><TT
CLASS="FUNCTION"
>setAdapterDirectProxy</TT
></A
></DT
><DD
><P
>Set the adapter endpoints with the locator registry.</P
></DD
><DT
><A
HREF="x3097.html#ATORREGISTRY.SETREPLICATEDADAPTERDIRECTPROXY"
><TT
CLASS="FUNCTION"
>setReplicatedAdapterDirectProxy</TT
></A
></DT
><DD
><P
>Set the adapter endpoints with the locator registry.</P
></DD
><DT
><A
HREF="x3097.html#ICE.LOCATORREGISTRY.SETSERVERPROCESSPROXY"
><TT
CLASS="FUNCTION"
>setServerProcessProxy</TT
></A
></DT
><DD
><P
>Set the process proxy for a server.</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="ICE.LOCATORREGISTRY.SETADAPTERDIRECTPROXY"
><TT
CLASS="LITERAL"
>setAdapterDirectProxy</TT
></A
></H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>[ "amd" ]
<SPAN
CLASS="TYPE"
>void</SPAN
> <TT
CLASS="FUNCTION"
>setAdapterDirectProxy</TT
>(<SPAN
CLASS="TYPE"
>string</SPAN
> <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>,
    <SPAN
CLASS="TYPE"
>Object*</SPAN
> <TT
CLASS="PARAMETER"
><I
>proxy</I
></TT
>)
    throws
	<A
HREF="x1054.html"
><CODE
CLASS="CLASSNAME"
>AdapterNotFoundException</CODE
></A
>,
	<A
HREF="x1036.html"
><CODE
CLASS="CLASSNAME"
>AdapterAlreadyActiveException</CODE
></A
>;</PRE
></TD
></TR
></TABLE
><P
>Set the adapter endpoints with the locator registry.</P
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN3147"
>Parameters</A
></H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="PARAMETER"
><I
>adapterId</I
></TT
></DT
><DD
><P
>			    The adapter id.</P
></DD
><DT
><TT
CLASS="PARAMETER"
><I
>proxy</I
></TT
></DT
><DD
><P
>			    The adapter proxy (a dummy direct proxy created
by the adapter). The direct proxy contains the adapter
endpoints.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN3160"
>Exceptions</A
></H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><A
HREF="x1054.html"
><CODE
CLASS="CLASSNAME"
>AdapterNotFoundException</CODE
></A
></DT
><DD
><P
>			    Raised if the adapter cannot
be found, or if the locator only allows
registered adapters to set their active proxy and the
adapter is not registered with the locator.</P
></DD
><DT
><TT
CLASS="LITERAL"
>AdapterAlreadyActive</TT
></DT
><DD
><P
>			    Raised if an adapter with the same
id is already active.</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="ATORREGISTRY.SETREPLICATEDADAPTERDIRECTPROXY"
><TT
CLASS="LITERAL"
>setReplicatedAdapterDirectProxy</TT
></A
></H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>[ "amd" ]
<SPAN
CLASS="TYPE"
>void</SPAN
> <TT
CLASS="FUNCTION"
>setReplicatedAdapterDirectProxy</TT
>(<SPAN
CLASS="TYPE"
>string</SPAN
> <TT
CLASS="PARAMETER"
><I
>adapterId</I
></TT
>,
    <SPAN
CLASS="TYPE"
>string</SPAN
> <TT
CLASS="PARAMETER"
><I
>replicaGroupId</I
></TT
>,
    <SPAN
CLASS="TYPE"
>Object*</SPAN
> <TT
CLASS="PARAMETER"
><I
>proxy</I
></TT
>)
    throws
	<A
HREF="x1054.html"
><CODE
CLASS="CLASSNAME"
>AdapterNotFoundException</CODE
></A
>,
	<A
HREF="x1036.html"
><CODE
CLASS="CLASSNAME"
>AdapterAlreadyActiveException</CODE
></A
>,
	<A
HREF="x2974.html"
><CODE
CLASS="CLASSNAME"
>InvalidReplicaGroupIdException</CODE
></A
>;</PRE
></TD
></TR
></TABLE
><P
>Set the adapter endpoints with the locator registry.</P
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN3193"
>Parameters</A
></H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="PARAMETER"
><I
>adapterId</I
></TT
></DT
><DD
><P
>			    The adapter id.</P
></DD
><DT
><TT
CLASS="PARAMETER"
><I
>replicaGroupId</I
></TT
></DT
><DD
><P
>			    The replica group id.</P
></DD
><DT
><TT
CLASS="PARAMETER"
><I
>proxy</I
></TT
></DT
><DD
><P
>			    The adapter proxy (a dummy direct proxy created
by the adapter). The direct proxy contains the adapter
endpoints.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN3211"
>Exceptions</A
></H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><A
HREF="x1054.html"
><CODE
CLASS="CLASSNAME"
>AdapterNotFoundException</CODE
></A
></DT
><DD
><P
>			    Raised if the adapter cannot
be found, or if the locator only allows registered adapters to
set their active proxy and the adapter is not registered with
the locator.</P
></DD
><DT
><TT
CLASS="LITERAL"
>AdapterAlreadyActive</TT
></DT
><DD
><P
>			    Raised if an adapter with the same
id is already active.</P
></DD
><DT
><A
HREF="x2974.html"
><CODE
CLASS="CLASSNAME"
>InvalidReplicaGroupIdException</CODE
></A
></DT
><DD
><P
>			    Raised if the given
replica group doesn't match the one registered with the
locator registry for this object adapter.</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="ICE.LOCATORREGISTRY.SETSERVERPROCESSPROXY"
><TT
CLASS="LITERAL"
>setServerProcessProxy</TT
></A
></H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>[ "amd" ]
<SPAN
CLASS="TYPE"
>void</SPAN
> <TT
CLASS="FUNCTION"
>setServerProcessProxy</TT
>(<SPAN
CLASS="TYPE"
>string</SPAN
> <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>,
    <CODE
CLASS="CLASSNAME"
>Process*</CODE
> <TT
CLASS="PARAMETER"
><I
>proxy</I
></TT
>)
    throws
	<A
HREF="x6034.html"
><CODE
CLASS="CLASSNAME"
>ServerNotFoundException</CODE
></A
>;</PRE
></TD
></TR
></TABLE
><P
>Set the process proxy for a server.</P
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN3244"
>Parameters</A
></H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="PARAMETER"
><I
>id</I
></TT
></DT
><DD
><P
>			    The server id.</P
></DD
><DT
><TT
CLASS="PARAMETER"
><I
>proxy</I
></TT
></DT
><DD
><P
>			    The process proxy.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN3257"
>Exceptions</A
></H3
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><A
HREF="x6034.html"
><CODE
CLASS="CLASSNAME"
>ServerNotFoundException</CODE
></A
></DT
><DD
><P
>			    Raised if the server cannot
be found.</P
></DD
></DL
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="x2989.html"
ACCESSKEY="P"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x3266.html"
ACCESSKEY="N"
>Next &#62;&#62;&#62;</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><TT
CLASS="LITERAL"
>Ice::Locator</TT
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c13.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><TT
CLASS="LITERAL"
>Ice::Logger</TT
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>