<!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: beepprofile.c 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>beepprofile.c File Reference</h1>Implementation of the BEEP Profile Object.
<a href="#_details">More...</a>
<p>
<code>#include <assert.h></code><br>
<code>#include "<a class="el" href="config_8h-source.html">config.h</a>"</code><br>
<code>#include "<a class="el" href="liblogging_8h-source.html">liblogging.h</a>"</code><br>
<code>#include "<a class="el" href="beepprofile_8h-source.html">beepprofile.h</a>"</code><br>
<code>#include "<a class="el" href="namevaluetree_8h-source.html">namevaluetree.h</a>"</code><br>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="beepprofile_8c.html#a0">sbProfGetURI</a> (<a class="el" href="structsbProfObject.html">sbProfObj</a> *pThis)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the profile URI. </em> <a href="#a0"></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="beepprofile_8c.html#a1">sbProfConstruct</a> (<a class="el" href="structsbProfObject.html">sbProfObj</a> **ppThis, char *pszURI)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to create a sbProf. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="beepprofile.c::sbProfDestroy"></a>
void </td><td class="memItemRight" valign=bottom><a class="el" href="beepprofile_8c.html#a2">sbProfDestroy</a> (<a class="el" href="structsbProfObject.html">sbProfObj</a> *pThis)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Profile Object Destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structsbProfObject.html">sbProfObj</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="beepprofile_8c.html#a3">sbProfFindProfileURIMatch</a> (sbNVTRObj *pProfListLocal, sbNVTRObj *pURIListRemote)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a list of profile objects AND a list of (remotely supported) profile URIs and find a match in them. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a4" doxytag="beepprofile.c::sbProfFindProfileMatch"></a>
<a class="el" href="structsbProfObject.html">sbProfObj</a> * </td><td class="memItemRight" valign=bottom><b>sbProfFindProfileMatch</b> (sbNVTRObj *pProfListRemote, sbNVTRObj *pProfList2)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="beepprofile.c::sbProfFindProfile"></a>
<a class="el" href="structsbProfObject.html">sbProfObj</a> * </td><td class="memItemRight" valign=bottom><b>sbProfFindProfile</b> (sbNVTRObj *pProfList, char *pszSearch)</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="beepprofile_8c.html#a6">sbProfSetClntEventHandlers</a> (<a class="el" href="structsbProfObject.html">sbProfObj</a> *pProf, <a class="el" href="liblogging_8h.html#a6">srRetVal</a>(*OnClntOpenLogChan)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan), <a class="el" href="liblogging_8h.html#a6">srRetVal</a>(*OnClntSendLogMsg)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan, char *szLogmsg), <a class="el" href="liblogging_8h.html#a6">srRetVal</a>(*OnClntSendSLMG)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan, struct srSLMGObject *pSLMG), <a class="el" href="liblogging_8h.html#a6">srRetVal</a>(*OnClntCloseLogChan)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the 4 mandatory event handlers for client profiles. </em> <a href="#a6"></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="beepprofile_8c.html#a7">sbProfSetAPIObj</a> (<a class="el" href="structsbProfObject.html">sbProfObj</a> *pThis, <a class="el" href="structsrAPIObject.html">srAPIObj</a> *pAPI)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the associated API object. </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a8" doxytag="beepprofile.c::sbProfSetEventHandler"></a>
<a class="el" href="liblogging_8h.html#a6">srRetVal</a> </td><td class="memItemRight" valign=bottom><b>sbProfSetEventHandler</b> (<a class="el" href="structsbProfObject.html">sbProfObj</a> *pThis, sbProfEvent iEvent, <a class="el" href="liblogging_8h.html#a6">srRetVal</a>(*handler)())</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Implementation of the BEEP Profile Object.
<p>
<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<p>
2003-09-04 begin coding support for multiple client profiles (the initial design just allowed one).</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>Function Documentation</h2>
<a name="a1" doxytag="beepprofile.c::sbProfConstruct"></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> sbProfConstruct </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbProfObject.html">sbProfObj</a> ** </td>
<td class="mdname" nowrap> <em>ppThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>char * </td>
<td class="mdname" nowrap> <em>pszURI</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>
Constructor to create a sbProf.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>ppThis</em> </td><td>[out] pointer to a buffer that will receive the pointer to the newly created profile object. </td></tr>
<tr><td valign=top><em>szURI</em> </td><td>[in] - name of uri to be used in greeting. May be NULL for a profile, that should not be advertised (channel 0 is a meaningful sample). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a3" doxytag="beepprofile.c::sbProfFindProfileURIMatch"></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="structsbProfObject.html">sbProfObj</a>* sbProfFindProfileURIMatch </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">sbNVTRObj * </td>
<td class="mdname" nowrap> <em>pProfListLocal</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>sbNVTRObj * </td>
<td class="mdname" nowrap> <em>pURIListRemote</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>
Take a list of profile objects AND a list of (remotely supported) profile URIs and find a match in them.
<p>
The matching is done so that the first local profile found in the remote URI list will be returned. If there are multiple matches, all other matches will be IGNORED.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pProfListLocal</em> </td><td>List of locally supported profile objects.</td></tr>
<tr><td valign=top><em>pURIListRemote</em> </td><td>List of remotely supported profile URIs.</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>The</em> </td><td>matching profile object from the local profile object. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a0" doxytag="beepprofile.c::sbProfGetURI"></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"> char* sbProfGetURI </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbProfObject.html">sbProfObj</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>
Return the profile URI.
<p>
The returned string is read-only. <dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>URI</em> </td><td>profile string </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a7" doxytag="beepprofile.c::sbProfSetAPIObj"></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> sbProfSetAPIObj </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbProfObject.html">sbProfObj</a> * </td>
<td class="mdname" nowrap> <em>pThis</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structsrAPIObject.html">srAPIObj</a> * </td>
<td class="mdname" nowrap> <em>pAPI</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>
Set the associated API object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pAPI</em> </td><td>- API object to be set. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a6" doxytag="beepprofile.c::sbProfSetClntEventHandlers"></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> sbProfSetClntEventHandlers </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structsbProfObject.html">sbProfObj</a> * </td>
<td class="mdname" nowrap> <em>pProf</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="liblogging_8h.html#a6">srRetVal</a>(* </td>
<td class="mdname" nowrap> <em>OnClntOpenLogChan</em>)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan), </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="liblogging_8h.html#a6">srRetVal</a>(* </td>
<td class="mdname" nowrap> <em>OnClntSendLogMsg</em>)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan, char *szLogmsg), </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="liblogging_8h.html#a6">srRetVal</a>(* </td>
<td class="mdname" nowrap> <em>OnClntSendSLMG</em>)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan, struct srSLMGObject *pSLMG), </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="liblogging_8h.html#a6">srRetVal</a>(* </td>
<td class="mdname" nowrap> <em>OnClntCloseLogChan</em>)(struct <a class="el" href="structsbChanObject.html">sbChanObject</a> *pChan)</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>
Set the 4 mandatory event handlers for client profiles.
<p>
As all of them need to be set for the profile to work, we provide a single call to set them all at once.<p>
The param names reflect the names of the event handlers. All event handlers MUST point to actual handlers, none if them is allowed to be NULL. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Mon Oct 3 12:29:55 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>
