srAPI-lstn.c File Reference

Implementation of the listener part of the API. More...

#include <assert.h>
#include "config.h"
#include "liblogging.h"
#include "beepsession.h"
#include "beepprofile.h"
#include "beeplisten.h"
#include "lstnprof-3195raw.h"
#include "lstnprof-3195cooked.h"
#include "srAPI.h"
#include "syslogmessage.h"
#include "namevaluetree.h"

Functions
srRetVal	srAPISetMsgRcvCallback (srAPIObj *pThis, void(*NewHandler)(srAPIObj *, srSLMGObj *))
srRetVal	srAPISetupListener (srAPIObj *pThis, void(*NewHandler)(srAPIObj *, srSLMGObj *))
srRetVal	srAPIRunListener (srAPIObj *pThis)
	Run the listener process.
srRetVal	srAPIShutdownListener (srAPIObj *pThis)
	Shut down the currently running listener.

---

Detailed Description

Implementation of the listener part of the API.

Author:

Rainer Gerhards <rgerhards@adiscon.com>

Date:

2003-08-26 begun coding on initial version.

Copyright 2002-2003 Rainer Gerhards and Adiscon GmbH. All Rights Reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* 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.

* 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.

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.

---

Function Documentation

srRetVal srAPIRunListener (  srAPIObj *  pThis  )

Run the listener process. Control is only returned if a fatal error inside the listener happens srAPIShutdownListener() has been called As control does not return, please note that srAPIShutdownListener() must be called either from another thread or a signal handler.

srRetVal srAPIShutdownListener (  srAPIObj *  pThis  )

Shut down the currently running listener. It may take some time to shutdown the listener depending on its current state. The caller should expect a delay of up to 30 seconds.

---