<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>liblogging: beepsession.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>beepsession.h File Reference</h1>The BEEP Session Object.
<a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="beepchannel_8h-source.html">beepchannel.h</a>"</code><br>
<code>#include "<a class="el" href="beepprofile_8h-source.html">beepprofile.h</a>"</code><br>
<p>
<a href="beepsession_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structsbSessObject.html">sbSessObject</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The session object. </em> <a href="structsbSessObject.html#_details">More...</a><em><br><br></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a0" doxytag="beepsession.h::__LIB3195_BEEPSESSION_H_INCLUDED__"></a>
#define </td><td class="memItemRight" valign=bottom><b>__LIB3195_BEEPSESSION_H_INCLUDED__</b> 1</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a1" doxytag="beepsession.h::sbSessCHECKVALIDOBJECT"></a>
#define </td><td class="memItemRight" valign=bottom><b>sbSessCHECKVALIDOBJECT</b>(x) {assert((x) != NULL); assert((x)->OID == OIDsbSess);}</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="beepsession.h::sbSessGetLastError"></a>
#define </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a2">sbSessGetLastError</a>(pThis) pThis->iLastErr</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Getthe last error for this module. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="beepsession.h::sbSessSetLastError"></a>
#define </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a3">sbSessSetLastError</a>(pThis, iRet) pThis->iLastErr = iRet</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the last error for this module. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a4" doxytag="beepsession.h::sbSessResetLastError"></a>
#define </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a4">sbSessResetLastError</a>(pThis) pThis->iLastErr = SR_RET_OK</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">reset the last error for this module <br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="beepsession.h::sbSessState"></a>
typedef enum <a class="el" href="beepsession_8h.html#a27">sbSessState_</a> </td><td class="memItemRight" valign=bottom><b>sbSessState</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a6" doxytag="beepsession.h::sbSessTXState"></a>
typedef enum <a class="el" href="beepsession_8h.html#a28">sbSessTXState_</a> </td><td class="memItemRight" valign=bottom><b>sbSessTXState</b></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a7" doxytag="beepsession.h::sbSessObj"></a>
typedef <a class="el" href="structsbSessObject.html">sbSessObject</a> </td><td class="memItemRight" valign=bottom><b>sbSessObj</b></td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a27">sbSessState_</a> { <b>sbSESSSTATE_OPEN</b>,
<a class="el" href="beepsession_8h.html#a27a9">sbSESSSTATE_CLOSED</a>,
<a class="el" href="beepsession_8h.html#a27a10">sbSESSSTATE_UNKNOWN</a> = 0
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Session status. </em> <a href="#a27">More...</a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a28">sbSessTXState_</a> { <a class="el" href="beepsession_8h.html#a28a11">sbSESSTXSTATE_NO_TX_PENDING</a>,
<a class="el" href="beepsession_8h.html#a28a12">sbSESSTXSTATE_IN_TX</a>,
<a class="el" href="beepsession_8h.html#a28a13">sbSESSTXSTATE_UNKNOWN</a> = 0
}</td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a14">sbSessOpenSession</a> (char *pszRemotePeer, int iPort, struct sbNVTRObject *pProfSupported)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a BEEP session. </em> <a href="#a14"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a15">sbSessCloseSession</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the BEEP session. </em> <a href="#a15"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structsbChanObject.html">sbChanObject</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a16">sbSessRetrChanObj</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis, <a class="el" href="liblogging_8h.html#a7">SBchannel</a> uChanNo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the channel object associated with the channel number. </em> <a href="#a16"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structsbFramObject.html">sbFramObject</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a17">sbSessRecvFram</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis, struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a frame for a specified channel from the tcp stream. </em> <a href="#a17"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structsbChanObject.html">sbChanObject</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a18">sbSessOpenChan</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a BEEP channel on an established session. </em> <a href="#a18"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a19">sbSessCloseChan</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis, struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a channel. </em> <a href="#a19"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a20">sbSessDoReceive</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis, int bMustRcvPayloadFrame)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive frames off the tcp stream. </em> <a href="#a20"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a21">sbSessSendFram</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis, struct <a class="el" href="structsbFramObject.html">sbFramObject</a> *pFram, struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the provided frame on the provided channel. </em> <a href="#a21"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a22">sbSessDestroy</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. </em> <a href="#a22"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a23">sbSessRemoteOpen</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> **pThis, <a class="el" href="structsbSockObject.html">sbSockObj</a> *pSock, struct sbNVTRObject *pProfSupported)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a BEEP session. </em> <a href="#a23"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a24">sbSessAbort</a> (<a class="el" href="structsbSessObject.html">sbSessObj</a> *pThis)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a session without any further communication. </em> <a href="#a24"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a25">sbSessProcessGreeting</a> (struct <a class="el" href="structsbSessObject.html">sbSessObject</a> *pThis, struct <a class="el" href="structsbMesgObject.html">sbMesgObject</a> *pMesg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process the remote peer's greeting message. </em> <a href="#a25"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><a class="el" href="beepsession_8h.html#a26">sbSessSendGreeting</a> (struct <a class="el" href="structsbSessObject.html">sbSessObject</a> *pSess, struct sbNVTRObject *pProfsSupported)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a greeting message based on the currently registered profiles. </em> <a href="#a26"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The BEEP Session Object.
<p>
<dl compact><dt><b>Note:</b></dt><dd>The current implementation only supports 2 channels - the control channel plus 1 payload channel.</dd></dl>
<dl compact><dt><b>Author:</b></dt><dd>Rainer Gerhards <<a href="mailto:rgerhards@adiscon.com">rgerhards@adiscon.com</a>> </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>2003-08-04 0.1 version created.<p>
2003-08-07 name value list for channnels added.</dd></dl>
Copyright 2002-2003 Rainer Gerhards and Adiscon GmbH. All Rights Reserved.<p>
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:<p>
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.<p>
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.<p>
* Neither the name of Adiscon GmbH or Rainer Gerhards nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.<p>
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<hr><h2>Enumeration Type Documentation</h2>
<a name="a27" doxytag="beepsession.h::sbSessState_"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum <a class="el" href="beepsession_8h.html#a27">sbSessState_</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Session status.
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="a27a9" doxytag="sbSESSSTATE_CLOSED"></a><em>sbSESSSTATE_CLOSED</em></em> </td><td>
session is closed and ready to be removed from whatever queues it is in </td></tr>
<tr><td valign=top><em><a name="a27a10" doxytag="sbSESSSTATE_UNKNOWN"></a><em>sbSESSSTATE_UNKNOWN</em></em> </td><td>
should never happen
<p>
Set after initialization. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a28" doxytag="beepsession.h::sbSessTXState_"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum <a class="el" href="beepsession_8h.html#a28">sbSessTXState_</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="a28a11" doxytag="sbSESSTXSTATE_NO_TX_PENDING"></a><em>sbSESSTXSTATE_NO_TX_PENDING</em></em> </td><td>
no transmit pending </td></tr>
<tr><td valign=top><em><a name="a28a12" doxytag="sbSESSTXSTATE_IN_TX"></a><em>sbSESSTXSTATE_IN_TX</em></em> </td><td>
data is currently being send </td></tr>
<tr><td valign=top><em><a name="a28a13" doxytag="sbSESSTXSTATE_UNKNOWN"></a><em>sbSESSTXSTATE_UNKNOWN</em></em> </td><td>
should never happen
<p>
Set after initialization. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a24" doxytag="beepsession.h::sbSessAbort"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void sbSessAbort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pThis</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Close a session without any further communication.
<p>
Can be used to abort a connection if<ul>
<li>the remote peer broke it</li><li>we have a protocol error and we need to break it</li></ul>
<p>
This method is void, because it *must* complete, no matter which errors it encounters. Furthermore, it is primarily intended to be called from destructors which are also void. Consider it to be an extended desctrutor. </td>
</tr>
</table>
<a name="a19" doxytag="beepsession.h::sbSessCloseChan"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="liblogging_8h.html#a6">srRetVal</a> sbSessCloseChan </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct <a class="el" href="structsbChanObject.html">sbChanObject</a> * </td>
<td class="mdname" nowrap> <em>pChan</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Close a channel.
<p>
This is a very partial implementation of RFC 3080. For syslog-raw, I honestly and strongly beliefe it works. However, there may be implementations of syslog raw where it will not work or at least not work fully correctly.<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000014">Todo:</a></b></dt><dd>This method (and some of the plumbing behind) must be updated to be fully compliant to RFC 3080. </dd></dl>
Issues are:<ul>
<li>we do not expect other messages to come in during the session</li><li>if the remote peer closes the session before us, we may be in trouble</li></ul>
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pChan</em> </td><td>[in] Channel to be closed. Will be destroyed at the end of the execution and thus can no longer be used after this method call! </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a15" doxytag="beepsession.h::sbSessCloseSession"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="liblogging_8h.html#a6">srRetVal</a> sbSessCloseSession </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pThis</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Closes the BEEP session.
<p>
First, the management channel (channel 0) is taken down and then the TCP stream is closed. This function can only be called after all sessions have been closed. Once the function returns, the session object is no longer valid and can no longer be used. </td>
</tr>
</table>
<a name="a22" doxytag="beepsession.h::sbSessDestroy"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void sbSessDestroy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pThis</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
pThis is invalid when this function returns. The caller can no longer use it. The caller is also not allowed to free it - this is already done in this method. </td>
</tr>
</table>
<a name="a20" doxytag="beepsession.h::sbSessDoReceive"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="liblogging_8h.html#a6">srRetVal</a> sbSessDoReceive </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>bMustRcvPayloadFrame</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Receive frames off the tcp stream.
<p>
SEQ frames are processed as they arrive. Other frames are buffered in the respective in-memory queue. This is a helper to <a class="el" href="beepsession_8h.html#a17">sbSessRecvFram()</a> and <a class="el" href="beepsession_8h.html#a21">sbSessSendFram()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>bMustRcvPayloadFrame</em> </td><td>A boolean indicating if an actual payload frame must be received. If set to TRUE, the method blocks until a payload frame is received. All interim SEQ frames are processed, but will not make this method to return. If FALSE, the method will block until anything is received, including a SEQ. If a SEQ is received, it will be processed and the method returns. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a18" doxytag="beepsession.h::sbSessOpenChan"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> struct <a class="el" href="structsbChanObject.html">sbChanObject</a>* sbSessOpenChan </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pThis</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Open a BEEP channel on an established session.
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000013">Todo:</a></b></dt><dd>think if we need to shut down anything else inside the BEEP session. <p>
think if we need to shut down anything else inside the BEEP session. </dd></dl>
</td>
</tr>
</table>
<a name="a14" doxytag="beepsession.h::sbSessOpenSession"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structsbSessObject.html">sbSessObj</a>* sbSessOpenSession </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname" nowrap> <em>pszRemotePeer</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>iPort</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct sbNVTRObject * </td>
<td class="mdname" nowrap> <em>pProfSupported</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Open a BEEP session.
<p>
The initial greeting is sent and the remote peers initial greeting is accepted. Channel 0 is initialized and brought into operation.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pszRemotePeer</em> </td><td>name or IP address of the peer to connect to </td></tr>
<tr><td valign=top><em>iPort</em> </td><td>TCP port the remote peer is listening to </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pointer</em> </td><td>to the new session object or NULL, if an error occured. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a25" doxytag="beepsession.h::sbSessProcessGreeting"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="liblogging_8h.html#a6">srRetVal</a> sbSessProcessGreeting </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">struct <a class="el" href="structsbSessObject.html">sbSessObject</a> * </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct <a class="el" href="structsbMesgObject.html">sbMesgObject</a> * </td>
<td class="mdname" nowrap> <em>pMesg</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Process the remote peer's greeting message.
<p>
Most importantly, the list of profiles is extracted and stored in the session object.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pMesg</em> </td><td>The message containing the Greeting. Must not be NULL. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a17" doxytag="beepsession.h::sbSessRecvFram"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> struct <a class="el" href="structsbFramObject.html">sbFramObject</a>* sbSessRecvFram </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct <a class="el" href="structsbChanObject.html">sbChanObject</a> * </td>
<td class="mdname" nowrap> <em>pChan</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Receive a frame for a specified channel from the tcp stream.
<p>
This method handles intermixed frames from other channels. It calls back into the frame object to do the actual frame read (if no frame is buffered).<p>
See <a class="el" href="architecture_8c.html">architecture::c</a> for a full description.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pChan</em> </td><td>the associated channel </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pointer</em> </td><td>to the new frame object or NULL, if an error occured. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a23" doxytag="beepsession.h::sbSessRemoteOpen"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="liblogging_8h.html#a6">srRetVal</a> sbSessRemoteOpen </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> ** </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structsbSockObject.html">sbSockObj</a> * </td>
<td class="mdname" nowrap> <em>pSock</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct sbNVTRObject * </td>
<td class="mdname" nowrap> <em>pProfSupported</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Open a BEEP session.
<p>
This method is called if a REMOTE peer requests an session open. As such, it does only the most pressing initialization work and then returns back to the caller. </td>
</tr>
</table>
<a name="a16" doxytag="beepsession.h::sbSessRetrChanObj"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> struct <a class="el" href="structsbChanObject.html">sbChanObject</a>* sbSessRetrChanObj </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="liblogging_8h.html#a7">SBchannel</a> </td>
<td class="mdname" nowrap> <em>uChanNo</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieve the channel object associated with the channel number.
<p>
This method allows to retrieve a channel number based on the actual channel.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>uChanNo</em> </td><td>channel number </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pointer</em> </td><td>to channel object or NULL, if uChanNo could not be found. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a21" doxytag="beepsession.h::sbSessSendFram"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="liblogging_8h.html#a6">srRetVal</a> sbSessSendFram </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbSessObject.html">sbSessObj</a> * </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct <a class="el" href="structsbFramObject.html">sbFramObject</a> * </td>
<td class="mdname" nowrap> <em>pFram</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct <a class="el" href="structsbChanObject.html">sbChanObject</a> * </td>
<td class="mdname" nowrap> <em>pChan</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Send the provided frame on the provided channel.
<p>
While sending, concurrently incoming frames are buffered and SEQ frames are processed. This method blocks until pFram could be sent (this means it may need to wait for the proper SEQ frame).<p>
See <a class="el" href="architecture_8c.html">architecture::c</a> for full details on how this method "drives the BEEP stack".<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pFram</em> </td><td>[in] frame to be send </td></tr>
<tr><td valign=top><em>pChan</em> </td><td>[in] channel where pFram is to be sent over </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a26" doxytag="beepsession.h::sbSessSendGreeting"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="liblogging_8h.html#a6">srRetVal</a> sbSessSendGreeting </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">struct <a class="el" href="structsbSessObject.html">sbSessObject</a> * </td>
<td class="mdname" nowrap> <em>pSess</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>struct sbNVTRObject * </td>
<td class="mdname" nowrap> <em>pProfsSupported</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Send a greeting message based on the currently registered profiles.
<p>
We generate the greeting via a simple stringbuf, not with an XML parser. This saves execution time and is as good as the XML thing...<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pProfsSupported</em> </td><td>Pointer to a linked list of supported profiles (which should be specified in the greeting. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Mon Oct 3 12:29:56 2005 for liblogging by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.2 </small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
e9fca32892116c2c27cf46145520942a
>
files
>
38
