mirror of
https://github.com/falk-werner/webfuse
synced 2024-10-27 20:34:10 +00:00
88 lines
2.8 KiB
C
88 lines
2.8 KiB
C
////////////////////////////////////////////////////////////////////////////////
|
|
/// \file webfuse/server.h
|
|
/// \brief Adapter server.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef WF_SERVER_H
|
|
#define WF_SERVER_H
|
|
|
|
#include "webfuse/api.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
//------------------------------------------------------------------------------
|
|
/// \struct wf_server
|
|
/// \brief Webfuse adapter server object.
|
|
//------------------------------------------------------------------------------
|
|
struct wf_server;
|
|
|
|
struct wf_server_config;
|
|
|
|
//------------------------------------------------------------------------------
|
|
/// \brief Creates a new server.
|
|
///
|
|
/// \param config pointer to server configuration.
|
|
/// \return newly created server or NULL in case of an error
|
|
//------------------------------------------------------------------------------
|
|
extern WF_API struct wf_server * wf_server_create(
|
|
struct wf_server_config * config);
|
|
|
|
//------------------------------------------------------------------------------
|
|
/// \brief Disposes a server.
|
|
///
|
|
/// \note server configuration is not managed by server.
|
|
///
|
|
/// \param server pointer to server
|
|
//------------------------------------------------------------------------------
|
|
extern WF_API void wf_server_dispose(
|
|
struct wf_server * server);
|
|
|
|
//------------------------------------------------------------------------------
|
|
/// \brief Triggers the server.
|
|
///
|
|
/// This function must be invoked in a loop while the server is running. It
|
|
/// makes the server wait for the next event and processes it.
|
|
///
|
|
/// \param server pointer to server
|
|
///
|
|
/// \see wf_server_interrupt
|
|
//------------------------------------------------------------------------------
|
|
extern WF_API void wf_server_service(
|
|
struct wf_server * server);
|
|
|
|
//------------------------------------------------------------------------------
|
|
/// \brief Interrupts wf_server_service
|
|
///
|
|
/// This function can be used from another thread.
|
|
///
|
|
/// \param server pointer to server
|
|
///
|
|
/// \see wf_server_service
|
|
//------------------------------------------------------------------------------
|
|
extern WF_API void wf_server_interrupt(
|
|
struct wf_server * server);
|
|
|
|
//------------------------------------------------------------------------------
|
|
/// \brief Returns the port number used by the server
|
|
///
|
|
/// This function can be used to determine the port number of the server,
|
|
/// if it was configured to let the system choose a free port.
|
|
//
|
|
/// \param server pointer to server
|
|
/// \return Port number used by the server.
|
|
///
|
|
/// \see wf_server_config_set_port
|
|
//------------------------------------------------------------------------------
|
|
extern WF_API int wf_server_get_port(
|
|
struct wf_server const * server);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
|
|
#endif
|