rvi.h

Go to the documentation of this file.

/* Copyright (c) 2016, Jaguar Land Rover. All Rights Reserved.
 * 
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at http://mozilla.org/MPL/2.0.
 */

#ifndef _RVI_H
#define _RVI_H

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

// **********
// DATA TYPES
// **********

typedef void *TRviHandle;

typedef void (*TRviCallback) ( int fd, 
                                 void* serviceData, 
                                 const char *parameters
                               );

typedef enum {
    RVI_OK                  = 0,    
    RVI_ERR_OPENSSL         = 100,  
    RVI_ERR_NOCONFIG        = 1001, 
    RVI_ERR_JSON            = 1002, 
    RVI_ERR_SERVCERT        = 1003, 
    RVI_ERR_CLIENTCERT      = 1004, 
    RVI_ERR_NORCVCERT       = 1005, 
    RVI_ERR_STREAMEND       = 1006, 
    RVI_ERR_NOCRED          = 1007, 
    RVI_ERR_NOCMD           = 1008, 
    RVI_ERR_RIGHTS          = 1009,
    RVI_ERR_JSON_PART       = 1010
} ERviStatus;

// ***************************
// INITIALIZATION AND TEARDOWN
// ***************************

extern TRviHandle rviInit(char *configFilename);

extern int rviCleanup(TRviHandle handle);

// *************************
// RVI CONNECTION MANAGEMENT
// *************************

extern int rviConnect(TRviHandle handle, const char *addr, const char *port);

extern int rviDisconnect(TRviHandle handle, int fd);

extern int rviGetConnections(TRviHandle handle, int *conn, int *connSize);

// **********************
// RVI SERVICE MANAGEMENT
// **********************

extern int rviRegisterService( TRviHandle handle, const char *serviceName, 
                                 TRviCallback callback, 
                                 void* serviceData );

extern int rviUnregisterService( TRviHandle handle, 
                                   const char *serviceName );

extern int rviGetServices( TRviHandle handle, char **result, int* len );

extern int rviInvokeService( TRviHandle handle, 
                                      const char *serviceName, 
                                      const char *parameters );


// ******************
// RVI I/O MANAGEMENT
// ******************

extern int rviProcessInput(TRviHandle handle, int* fdArr, int fdLen);

#ifdef __cplusplus
}
#endif

#endif /* _RVI_H */