servers_manager.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.
*/
 
/*
 * servers_pool.h
 *
 *  Created on: 12 Jun 2015
 *      Author: tyrrells
 */
 
#ifndef SERVERS_POOL_H_
#define SERVERS_POOL_H_
 
#include "uuid_defs.h"
 
#include "connection.h"
#include "grassroots_service_manager_library.h"
#include "linked_list.h"
#include "operation.h"
#include "memory_allocations.h"
#include "string_utils.h"
 
 
typedef struct ExternalServer
{
  char *es_name_s;
 
  char *es_uri_s;
 
  Connection *es_connection_p;
 
  uuid_t es_id;
 
 
  LinkedList *es_paired_services_p;
 
 
} ExternalServer;
 
 
typedef struct ExternalServerNode
{
  ListItem esn_node;
 
  ExternalServer *esn_server_p;
 
  MEM_FLAG esn_server_mem;
} ExternalServerNode;
 
 
/* forward declaration */
struct ServersManager;
struct GrassrootsServer;
 
 
typedef ExternalServer *(*ExternalServerDeserialiser) (const unsigned char *data_p);
 
 
 
typedef unsigned char *(*ExternalServerSerialiser) (ExternalServer *server_p, uint32 *length_p);
 
 
typedef struct ServersManager
{
  struct Plugin *sm_plugin_p;
 
 
  uuid_t sm_server_id;
 
  char sm_server_id_s [UUID_STRING_BUFFER_SIZE];
 
 
  int (*sm_add_server_fn) (struct ServersManager *manager_p, ExternalServer *server_p, ExternalServerSerialiser serialise_fn);
 
  ExternalServer *(*sm_get_server_fn)  (struct ServersManager *manager_p, const char * const server_uri_s, ExternalServerDeserialiser deserialise_fn);
 
  ExternalServer *(*sm_remove_server_fn) (struct ServersManager *manager_p, const char * const server_uri_s, ExternalServerDeserialiser deserialise_fn);
 
 
 
  LinkedList *(*sm_get_all_servers_fn) (struct ServersManager *manager_p, ExternalServerDeserialiser deserialise_fn);
 
 
  void (*sm_free_servers_manager_fn) (struct ServersManager *manager_p);
 
 
  LinkedList *(*sm_get_all_matching_servers_fn) (struct ServersManager *manager_p, const char * const local_service_name_s);
 
 
} ServersManager;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_MANAGER_API ServersManager *LoadServersManager (const char *servers_manager_s, struct GrassrootsServer *server_p);
 
 
GRASSROOTS_SERVICE_MANAGER_LOCAL ServersManager *GetServersManagerFromPlugin (struct Plugin * const plugin_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API uuid_t *GetLocalServerId (struct GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API const char *GetLocalServerIdAsString (struct GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API void InitServersManager (ServersManager *manager_p,
                      int (*add_server_fn) (ServersManager *manager_p, ExternalServer *server_p, ExternalServerSerialiser serialise_fn),
                      ExternalServer *(*get_server_fn)  (ServersManager *manager_p, const char * const server_uri_s, ExternalServerDeserialiser deserialise_fn),
                      ExternalServer *(*remove_server_fn) (ServersManager *manager_p, const char * const server_uri_s, ExternalServerDeserialiser deserialise_fn),
                      LinkedList *(*get_all_servers_fn) (struct ServersManager *manager_p, ExternalServerDeserialiser deserialise_fn),
                      void (*free_servers_manager_fn) (struct ServersManager *manager_p));
 
 
GRASSROOTS_SERVICE_MANAGER_API int AddExternalServerToServersManager (ServersManager *manager_p, ExternalServer *server_p, ExternalServerSerialiser serialise_fn);
 
 
GRASSROOTS_SERVICE_MANAGER_API ExternalServer *GetExternalServerFromServersManager (ServersManager *manager_p, const char * const server_uri_s, ExternalServerDeserialiser deserialise_fn);
 
 
GRASSROOTS_SERVICE_MANAGER_API ExternalServer *RemoveExternalServerFromServersManager (ServersManager *manager_p, const char * const server_uri_s, ExternalServerDeserialiser deserialise_fn);
 
 
GRASSROOTS_SERVICE_MANAGER_API LinkedList *GetAllExternalServersFromServersManager (ServersManager *manager_p, ExternalServerDeserialiser deserialise_fn);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API void FreeServersManager (ServersManager *manager_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API json_t *AddExternalServerOperationsToJSON (ServersManager *manager_p, Operation op);
 
 
GRASSROOTS_SERVICE_MANAGER_API ExternalServer *AllocateExternalServer (const char *name_s, const char *uri_s, const char *uuid_s, ConnectionType ct);
 
 
GRASSROOTS_SERVICE_MANAGER_API void FreeExternalServer (ExternalServer *server_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API ExternalServerNode *AllocateExternalServerNode (ExternalServer *server_p, MEM_FLAG mf);
 
 
GRASSROOTS_SERVICE_MANAGER_API void FreeExternalServerNode (ListItem *node_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API json_t *MakeRemoteJSONCallToExternalServer (ExternalServer *server_p, json_t *request_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API bool AddExternalServerFromJSON (ServersManager *manager_p, const json_t *json_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API const char *GetRemotePairedServiceName (const ExternalServer * const src_p, const char * const local_service_name_s);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API ExternalServer *CreateExternalServerFromJSON (const json_t *json_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API unsigned char *SerialiseExternalServerToJSON (ExternalServer * const external_server_p, unsigned int *value_length_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API ExternalServer *DeserialiseExternalServerFromJSON (const unsigned char *raw_json_data_s);
 
 
GRASSROOTS_SERVICE_MANAGER_API json_t *GetExternalServerAsJSON (ExternalServer *server_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* SERVERS_POOL_H_ */