raw_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.
*/
 
/*
 * raw_connection.h
 *
 *  Created on: 16 Mar 2015
 *      Author: billy
 *
 * @brief A datatype to encapsulate Server-Client connections.
 * @addto@group network_group
 * @{
 */
 
#ifndef RAW_CONNECTION_H_
#define RAW_CONNECTION_H_
 
#include "jansson.h"
 
#include "network_library.h"
#include "typedefs.h"
 
/* forward declarations */
struct RawConnection;
struct Connection;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_NETWORK_API struct Connection *AllocateRawServerConnection (const char * const hostname_s, const char * const port_s);
 
 
 
 
GRASSROOTS_NETWORK_API int AtomicReceiveViaRawConnection (struct RawConnection *connection_p);
 
 
 
GRASSROOTS_NETWORK_API int AtomicSendStringViaRawConnection (const char *data_s, struct RawConnection *connection_p);
 
 
GRASSROOTS_NETWORK_API int AtomicSendViaRawConnection (const char *buffer_p, uint32 num_to_send, struct RawConnection *connection_p);
 
 
GRASSROOTS_NETWORK_LOCAL int SendJsonRequestViaRawConnection (struct RawConnection *connection_p, const json_t *json_p);
 
 
GRASSROOTS_NETWORK_LOCAL const char *GetRawConnectionData (struct Connection *connection_p);
 
 
GRASSROOTS_NETWORK_LOCAL bool MakeRemoteJsonCallViaRawConnection (struct Connection *connection_p, const json_t *req_p);
 
GRASSROOTS_NETWORK_LOCAL void FreeRawConnection (struct RawConnection *conn_p);
 
#ifdef __cplusplus
}
#endif
 
 
 
#endif    /* #ifndef RAW_CONNECTION_H_ */