connection.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
**     http://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
/*
 * connection.h
 *
 *  Created on: 16 Mar 2015
 *      Author: billy
 *
 * @brief A datatype to encapsulate Server-Client connections.
 * @addto@group network_group
 * @{
 */
 
#ifndef CONNECTION_H_
#define CONNECTION_H_
 
 
#include "typedefs.h"
#include "byte_buffer.h"
#include "curl_tools.h"
#include "network_library.h"
#include "jansson.h"
 
typedef enum
{
  CT_RAW,
 
  CT_WEB,
 
  CT_NUM_TYPES
} ConnectionType;
 
 
typedef struct Connection
{
  uint32 co_id;
 
  ConnectionType co_type;
} Connection;
 
 
 
 
typedef struct WebConnection
{
  Connection wc_base;
 
  CurlTool *wc_curl_p;
 
  char *wc_uri_s;
} WebConnection;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
 
GRASSROOTS_NETWORK_API Connection *AllocateWebServerConnection (const char * const full_uri_s, CurlMode curl_mode);
 
 
GRASSROOTS_NETWORK_API Connection *AllocaterRawClientConnection (int server_socket_fd);
 
 
GRASSROOTS_NETWORK_API const char *GetConnectionData (Connection *connection_p);
 
 
GRASSROOTS_NETWORK_API void FreeConnection (Connection *connection_p);
 
 
GRASSROOTS_NETWORK_API const char *MakeRemoteJsonCallViaConnection (Connection *connection_p, const json_t *req_p);
 
 
 
GRASSROOTS_NETWORK_API bool SetConnectionCredentials (Connection *connection_p, const char *username_s, const char *password_s);
 
 
GRASSROOTS_NETWORK_API bool InitConnection (Connection *connection_p, ConnectionType type);
 
 
GRASSROOTS_NETWORK_API void ReleaseConnection (Connection *connection_p);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* CONNECTION_H_ */