/*
* Copyright (c) 2013-2015, Christian Ferrari <tiian@users.sourceforge.net>
* All rights reserved.
*
* This file is part of FLoM and libflom (FLoM API client library)
*
* FLoM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2.0 as
* published by the Free Software Foundation.
*
* This file is part of libflom too and you can redistribute it and/or modify
* it under the terms of one of the following licences:
* - GNU General Public License version 2.0
* - GNU Lesser General Public License version 2.1
* as published by the Free Software Foundation.
*
* FLoM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License and
* GNU Lesser General Public License along with FLoM.
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef CLIENT_H
# define CLIENT_H
#include <config.h>
#include "flom_config.h"
#include "flom_conns.h"
#include "flom_trace.h"
/* save old FLOM_TRACE_MODULE and set a new value */
#ifdef FLOM_TRACE_MODULE
# define FLOM_TRACE_MODULE_SAVE FLOM_TRACE_MODULE
# undef FLOM_TRACE_MODULE
#else
# undef FLOM_TRACE_MODULE_SAVE
#endif /* FLOM_TRACE_MODULE */
#define FLOM_TRACE_MODULE FLOM_TRACE_MOD_CLIENT
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* Try to connect to flom daemon
* @param config IN configuration object, NULL for global config
* @param cd OUT connection data
* @param start_daemon IN try to start a new daemon if connection fails
* @result a reason code
*/
int flom_client_connect(flom_config_t *config,
struct flom_conn_data_s *cd, int start_daemon);
/**
* Try to connect to flom daemon using local (AF_LOCAL) socket
* @param config IN configuration object, NULL for global config
* @param cd OUT connection data
* @param start_daemon IN try to start a new daemon if connection fails
* @result a reason code
*/
int flom_client_connect_local(flom_config_t *config,
struct flom_conn_data_s *cd,
int start_daemon);
/**
* Try to connect to flom daemon using network (TCP/IP) socket
* @param config IN configuration object, NULL for global config
* @param cd OUT connection data
* @param start_daemon IN try to start a new daemon if connection fails
* @result a reason code
*/
int flom_client_connect_tcp(flom_config_t *config,
struct flom_conn_data_s *cd,
int start_daemon);
/**
* A TCP/IP connection chance: it can be reapeted after daemon start-up
* @param gai IN result obtained by getaddrinfo function
* @param fd OUT file descriptor associated to the connected socket
* @return the pointer to the element successfully connected, NULL if no
* element is available
*/
const struct addrinfo *flom_client_connect_tcp_try(
const struct addrinfo *gai, int *fd);
/**
* Discover flom daemon address using multicast UDP
* @param config IN configuration object, NULL for global config
* @param cd IN/OUT connection data
* @param start_daemon IN try to start a new daemon if connection fails
* @param family OUT AF_INET or AF_INET6
* @return a reason code
*/
int flom_client_discover_udp(flom_config_t *config,
struct flom_conn_data_s *cd,
int start_daemon,
sa_family_t *family);
/**
* Connect to a daemon using TCP/IP; daemon was previously discovered
* using multicast UDP/IP
* @param cd IN/OUT connection data
* @param sa IN address (IPv4 or IPv6) and port of daemon
* @param addrlen size of sa struct
* @return a reason code
*/
int flom_client_discover_udp_connect(struct flom_conn_data_s *cd,
const struct sockaddr *so,
socklen_t addrlen);
/**
* Disconnect from lock daemon
* @param cd IN/OUT connection data
* @result a reason code
*/
int flom_client_disconnect(struct flom_conn_data_s *cd);
/**
* Send lock command to the daemon
* @param config IN configuration object
* @param cd IN connection data
* @param timeout IN maximum wait time for lock acquisition
* @param element OUT the obtained element if the locked resource is of
* type resource set, NULL if the locked resource
* does not returns an element. The return name is null terminated.
* Note: the string allocated with g_malloc and MUST be freed by the
* caller using g_free!
* @return a reason code
*/
int flom_client_lock(flom_config_t *config, struct flom_conn_data_s *cd,
int timeout, char **element);
/**
* Wait while the desired resource is busy, then go on
* @param cd IN connection data
* @param msg IN/OUT message used to deserialize the replies
* @param timeout IN maximum wait time for lock acquisition
* @return a reason code
*/
int flom_client_wait_lock(struct flom_conn_data_s *cd,
struct flom_msg_s *msg, int timeout);
/**
* Send unlock command to the daemon
* @param config IN configuration object
* @param cd IN connection data
* @return a reason code
*/
int flom_client_unlock(flom_config_t *config,
struct flom_conn_data_s *cd);
/**
* Connect to daemon and send a shutdown message
* @param config IN configuration object, NULL for global config
* @param immediate IN is the shutdown immediate (else it's quiesce)
* @return a reason code
*/
int flom_client_shutdown(flom_config_t *config, int immediate);
#ifdef __cplusplus
}
#endif /* __cplusplus */
/* restore old value of FLOM_TRACE_MODULE */
#ifdef FLOM_TRACE_MODULE_SAVE
# undef FLOM_TRACE_MODULE
# define FLOM_TRACE_MODULE FLOM_TRACE_MODULE_SAVE
# undef FLOM_TRACE_MODULE_SAVE
#endif /* FLOM_TRACE_MODULE_SAVE */
#endif /* CLIENT_H */