cp_rest.h

Go to the documentation of this file.

/*
Copyright 2014 CloudPlugs Inc.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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.
*/
#ifndef CP_REST_H
#define CP_REST_H

#include <stddef.h>

#ifdef  __cplusplus
extern "C" {
#endif


typedef struct _cloudplugs_session* cp_session; 
#define CP_OK 0
#define CP_FAIL 1
typedef int cp_res; 
typedef int cp_bool; 
#define CP_TRUE 1
#define CP_FALSE 0



enum _CP_HTTP_RESULT {   
                CP_HTTP_OK = 200,
                CP_HTTP_CREATED = 201,
                CP_HTTP_MULTI_STATUS  =  207,
                CP_HTTP_BAD_REQUEST = 400,
                CP_HTTP_UNAUTHORIZED = 401,
                CP_HTTP_PAYMENT_REQUIRED = 402,
                CP_HTTP_FORBIDDEN = 403,
                CP_HTTP_NOT_FOUND = 404,
                CP_HTTP_NOT_ALLOWED = 405,
                CP_HTTP_NOT_ACCEPTABLE = 406,
                CP_HTTP_SERVER_ERROR = 500,
                CP_HTTP_NOT_IMPLEMENTED = 501,
                CP_HTTP_BAD_GATEWAY = 502,
                CP_HTTP_SERVICE_UNAVAILABLE = 503 };
typedef enum _CP_HTTP_RESULT CP_HTTP_RESULT;   
enum _CP_ERR_CODE { CP_ERR_INTERNAL_ERROR = -1,
                    CP_ERR_OUT_OF_MEMORY = -2,
                    CP_ERR_INVALID_SESSION = -3,
                    CP_ERR_QUERY_IS_NOT_AN_OBJECT = -4,
                    CP_ERR_QUERY_INVALID_TYPE = -5,
                    CP_ERR_HEADERS_MUST_BE_STRING = -6,
                    CP_ERR_INVALID_PARAMETER = -7,
                    CP_ERR_INVALID_LOGIN = -8,
                    CP_ERR_JSON_PARSE = -9,
                    CP_ERR_JSON_ENCODE = -10,
                    CP_ERR_INVALID_CONTENT_LENGTH = -11,
                    CP_ERR_HTTP = -12
                  };


typedef enum _CP_ERR_CODE CP_ERR_CODE; 
cp_res cloudplugs_global_init();

cp_res cloudplugs_global_shutdown();

cp_res cloudplugs_set_base_url(cp_session cps, const char* url);

cp_res cloudplugs_set_cacert(cp_session cps, const char* filename);

const char* cloudplugs_get_base_url(cp_session cps);

cp_res cloudplugs_set_timeout(cp_session cps, int timeout);

int cloudplugs_get_timeout(cp_session cps);

const char* cloudplugs_get_last_err_string(cp_session cps);

CP_ERR_CODE cloudplugs_get_last_err_code(cp_session cps);

const char* cloudplugs_get_last_http_result_string(cp_session cps);

CP_HTTP_RESULT cloudplugs_get_last_http_result(cp_session cps);


cp_session cloudplugs_create_session();

cp_res cloudplugs_set_auth(cp_session cps, const char* id, const char* pass, cp_bool is_master);

cp_res cloudplugs_ssl_verify(cp_session cps, cp_bool is_verified);

cp_bool cloudplugs_has_ssl_verify(cp_session cps);

cp_res cloudplugs_enable_ssl(cp_session cps, cp_bool is_enabled);

cp_bool cloudplugs_has_ssl(cp_session cps);

cp_res cloudplugs_get_auth_id(cp_session cps, char* id, size_t size);

cp_res cloudplugs_get_auth_pass(cp_session cps, char* password, size_t size);

cp_bool cloudplugs_is_auth_master(cp_session cps);

cp_res cloudplugs_destroy_session(cp_session cps);

cp_bool cloudplugs_extract_string_from_json(char **json, const char* key, char *res, const int n);

cp_res cloudplugs_enroll_product(cp_session cps, const char* body, char** result, size_t* result_length);

cp_res cloudplugs_enroll_prototype(cp_session cps, const char* body, char** result, size_t* result_length);

cp_res cloudplugs_enroll_ctrl(cp_session cps, const char* body, char** result, size_t* result_length);

cp_res cloudplugs_control_device(cp_session cps, const char* body, char** result, size_t* result_length);

cp_res cloudplugs_uncontrol_device(cp_session cps, const char* plugid, const char* plugid_controlled, char** result, size_t* result_length);

cp_res cloudplugs_get_device(cp_session cps, const char* plugid, char** result, size_t* result_length);

cp_res cloudplugs_get_device_prop(cp_session cps, const char* plugid, const char* prop, char** result, size_t* result_length);

cp_res cloudplugs_set_device_prop(cp_session cps, const char* plugid, const char* prop, const char* value);

cp_res cloudplugs_remove_device_prop(cp_session cps, const char* plugid, const char* prop);

cp_res cloudplugs_set_device(cp_session cps, const char* plugid, const char* value, char** result, size_t* result_length);

cp_res cloudplugs_unenroll(cp_session cps, const char* plugid, char** result, size_t* result_length);

cp_res cloudplugs_get_channel(cp_session cps, const char* channel_mask, const char* query, char** result, size_t* result_length);

cp_res cloudplugs_retrieve_data(cp_session cps, const char* channel_mask, const char* query, char** result, size_t* result_length);

cp_res cloudplugs_publish_data(cp_session cps, const char* channel, const char* body, char** result, size_t* result_length);

cp_res cloudplugs_remove_data(cp_session cps, const char* channel_mask, const char* body, char** result, size_t* result_length);

cp_res cloudplugs_set_device_location(cp_session cps, const char* plugid, double longitude, double latitude, double altitude, double accuracy, double timestamp);
cp_res cloudplugs_get_device_location(cp_session cps, const char* plugid, char** result, size_t* result_length);

#ifdef  __cplusplus
}
#endif

#endif //CP_REST_H