Sophie: coda-doc-5.2.0-4mdk noarch

coda-doc-5.2.0-4mdk.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
 <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
 <TITLE> RPC2 User Guide and Reference Manual: Multicast </TITLE>
 <LINK HREF="rpc2_manual-8.html" REL=next>
 <LINK HREF="rpc2_manual-6.html" REL=previous>
 <LINK HREF="rpc2_manual.html#toc7" REL=contents>
</HEAD>
<BODY>
<A HREF="rpc2_manual-8.html">Next</A>
<A HREF="rpc2_manual-6.html">Previous</A>
<A HREF="rpc2_manual.html#toc7">Contents</A>
<HR>
<H2><A NAME="s7">7. Multicast </A></H2>

<P>
<A NAME="Multicast"></A> <P>
<H2><A NAME="ss7.1">7.1 General Usage</A>
</H2>

<P>@center(<EM>Not written yet</EM>)
<P>
<H2><A NAME="ss7.2">7.2 Runtime Calls</A>
</H2>

<P>
<P>
<H3>RPC2_CreateMgrp -- <EM>Create a new RPC2 mgroup ID</EM> </H3>

<P>
<H3>Call:</H3>

<P><EM> RPC2_CreateMgrp(</EM> <B>out</B> RPC2_Handle *MgroupHandle, <B>in</B> RPC2_McastIdent *McastAddr, <B>in</B> RPC2_PortalIdent *McastPortal, <B>in</B> RPC2_SubsysIdent *Subsys,<B>in</B> RPC2_Integer SecurityLevel,<B>in</B> RPC2_EncryptionKey SessionKey,<B>in</B> RPC2_Integer EncryptionType,<B>in</B> long SideEffectType <EM>)</EM>
<H3>Parameters:</H3>

<P>
<DL>
<DT><B>MgroupHandle</B><DD><P>An integer, unique to a specific client, returned by the call. When combined with the clients network address, it uniquely identifies this mgroup connection. This is not necessarily a small-valued integer.,
<DT><B>McastAddr</B><DD><P>The IP multicast address of the desired multicast group.  This is the address that a server must use in a joingroup () system call.  Only MGRPBYINETADDR is supported at present.,
<DT><B>McastPortal</B><DD><P>The portal at which server (s) will be listening.  All servers in the multicast group must be listening at the same portal.,
<DT><B>Subsys</B><DD><P>The RPC2 subsystem corresponding to this multicast group.  Each server in the multicast group must have exported this subsystem.,
<DT><B>SecurityLevel</B><DD><P>same as in RPC2_Bind().,
<DT><B>SessionKey</B><DD><P>Encryption key to be used for all communication on this multicast channel.  RPC2 will send this (securely) to each server that is added via a RPC2_AddToMgrp)() call.,
<DT><B>EncryptionType</B><DD><P>same as in RPC2_Bind)().,
</DL>
<H3>Completion Codes:</H3>

<P>
<DL>
<DT><B>RPC2_SUCCESS)</B><DD><P>All went well,
<DT><B>RPC2_SEFAIL1)</B><DD><P>Side effect routines reported failure.,  
<DT><B>RPC2_SEFAIL2)</B><DD><P>Side effect routines reported failure.,
<DT><B>RPC2_FAIL),    </B><DD><P>Some other mishap occurred.,
</DL>
<H3>Description:</H3>

<P>Creates a new RPC2 mgroup identifier, unique to a particular &lt;multicastaddr, portal, subsystem&gt; combination, and returns it to the caller.  Once the identifier has been assigned, RPC2 mgroup members may be added and deleted via the RPC2_AddToMgrp) and RPC2_RemoveFromMgrp calls. The security level, encryption type and side effect types of each added connection must match the corresponding parameters of this RPC2_CreateMgrp call.
<P>
<H3>RPC2_AddToMgrp -- <EM>Add a connection ID (server) to an RPC2 mgroup</EM> </H3>

<P>
<H3>Call:</H3>

<P><EM>  RPC2_AddToMgrpAdd(</EM> <B>in</B> RPC2_Handle MgroupHandle,<B>in</B> RPC2_Handle) ConnHandle<EM>)</EM>
<H3>Parameters:</H3>

<P>
<DL>
<DT><B>MgroupHandle</B><DD><P>identifies the mgroup  to which the new server should be added,
<DT><B>ConnHandle</B><DD><P>identifies the connection to be added to the mgroup,
</DL>
<H3>Completion Codes:</H3>

<P>
<DL>
<DT><B>RPC2_SUCCESS</B><DD><P>All went well,
<DT><B>RPC2_NOMGROUP</B><DD><P>MgroupHandle is not a valid mgroup,
<DT><B>RPC2_NOCONNECTION</B><DD><P>ConnHandle is not a valid connection.,
<DT><B>RPC2_BADSECURITY</B><DD><P>SecurityLevel or EncryptionType of ConnHandle does not match that of Mgroup,
<DT><B>RPC2_DUPLICATEMEMBER</B><DD><P>ConnHandle is already a member of Mgroup,
<DT><B>RPC2_MGRPBUSY</B><DD><P>A call is in progress on MgroupHandle.,
<DT><B>RPC2_CONNBUSY</B><DD><P>A call is in progress on ConnHandle.,
<DT><B>RPC2_SEFAIL1</B><DD><P>Error code returned by side effect routine.,
<DT><B>RPC2_SEFAIL2</B><DD><P>Error code returned by side effect routine.,
<DT><B>RPC2_NAKED</B><DD><P>The remote site corresponding to ConnHandle sent an explicit negative acknowledgement.  This can happen if that site thought you were dead, or if someone at that site unbound your connection.,
<DT><B>RPC2_DEAD</B><DD><P>The remote site corresponding to ConnHandle has been deemed dead or unreachable,
<DT><B>RPC2_FAIL</B><DD><P>Some strange mishap occurred.,
</DL>
<H3>Description:</H3>

<P>Adds ConnHandle to the mgroup associated with MgroupHandle.  RPC2 contacts the remote site
to initialize its mgroup connection information.  The security level, encryption type
and side effect type of the connection being added must match that specified when Mgroup was defined.
<P>
<H3>RPC2_RemoveFromMgrp -- <EM>Remove a connection from an RPC2 mgroup</EM> </H3>

<P>
<H3>Call:</H3>

<P><EM>  RPC2_RemoveFromMgrp(</EM> <B>in</B> RPC2_Handle MgroupHandle, <B>in</B> ConnHandle <EM>)</EM>
<H3>Parameters:</H3>

<P>
<DL>
<DT><B>MgroupHandle</B><DD><P>the mgroup to be shrunk,
<DT><B>ConnHandle</B><DD><P>the connection to be removed from MgroupHandle,
</DL>
<H3>Completion Codes:</H3>

<P>
<DL>
<DT><B>RPC2_NOMGROUP</B><DD><P>MgroupHandle does not refer to a valid mgroup connection,
<DT><B>RPC2_NOCONNECTION</B><DD><P>ConnHandle is bogus.,
<DT><B>RPC2_NOTGROUPMEMBER</B><DD><P>ConnHandle is not a member of MgroupHandle.,
<DT><B>RPC2_MGRPBUSY</B><DD><P>A call is in progress on MgroupHandle,
<DT><B>RPC2_FAIL</B><DD><P>Some strange mishap occurred,
</DL>
<H3>Description:</H3>

<P>`Removes ConnHandle from the mgroup associated with MgroupHandle
<P>
<H3>RPC2_DeleteMgrp -- Delete a RPC2 mgroup </H3>

<P>
<H3>Call:</H3>

<P><EM>RPC2_DeleteMgrp  (</EM><B>in</B> RPC2_Handle MgroupHandle  <EM>)</EM>
<H3>Parameters:</H3>

<P>
<DL>
<DT><B>MgroupHandle</B><DD><P>the mgroup to be deleted,
</DL>
<H3>Completion Codes:</H3>

<P>
<DL>
<DT><B>RPC2_SUCCESS</B><DD><P>All went well,
<DT><B>RPC2_NOMGROUP</B><DD><P>MgroupHandle is bogus.,
<DT><B>RPC2_MGRPBUSY</B><DD><P>A call is in progress on MgroupHandle.,
<DT><B>RPC2_FAIL</B><DD><P>Some other mishap occurred.,
</DL>
<H3>Description:</H3>

<P>Deletes an mgroup, removing any existing members before deletion
<P>
<P>
<P>
<P>
<P>
<A NAME="LWPPart"></A> <P>
<HR>
<A HREF="rpc2_manual-8.html">Next</A>
<A HREF="rpc2_manual-6.html">Previous</A>
<A HREF="rpc2_manual.html#toc7">Contents</A>
</BODY>
</HTML>