st_thing_resource_api/inc/smartthings_resource.h

Go to the documentation of this file.

/*****************************************************************
 *
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * 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.
 *
 ******************************************************************/


#ifndef __SAMSUNG_EXPERIENCE_SERVICE_SMARTTHINGS_RESOURCE_H__
#define __SAMSUNG_EXPERIENCE_SERVICE_SMARTTHINGS_RESOURCE_H__

#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <tizen.h>
#include <smartthings_payload.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    SMARTTHINGS_RESOURCE_ERROR_NONE = TIZEN_ERROR_NONE,                                
    SMARTTHINGS_RESOURCE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,      
    SMARTTHINGS_RESOURCE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY,              
    SMARTTHINGS_RESOURCE_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED,      
    SMARTTHINGS_RESOURCE_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA,                          
    SMARTTHINGS_RESOURCE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED,              
    SMARTTHINGS_RESOURCE_ERROR_OPERATION_FAILED = TIZEN_ERROR_UNKNOWN - 1,             
    SMARTTHINGS_RESOURCE_ERROR_SERVICE_UNAVAILABLE = TIZEN_ERROR_UNKNOWN -2            
} smartthings_resource_error_e;

typedef enum {
    SMARTTHINGS_RESOURCE_REQUEST_GET = 0,              
    SMARTTHINGS_RESOURCE_REQUEST_SET = 1,              
    SMARTTHINGS_RESOURCE_REQUEST_COLLECTION_GET = 2,   
    SMARTTHINGS_RESOURCE_REQUEST_COLLECTION_SET = 3    
} smartthings_resource_req_type_e;

typedef enum {
    SMARTTHINGS_RESOURCE_CONNECTION_STATUS_CONNECTED = 0,          
    SMARTTHINGS_RESOURCE_CONNECTION_STATUS_DISCONNECTED,           
    SMARTTHINGS_RESOURCE_CONNECTION_STATUS_REJECTED,               
} smartthings_resource_connection_status_e;

typedef struct smartthings_resource_s *smartthings_resource_h;

typedef void (*smartthings_resource_connection_status_cb)(smartthings_resource_h handle, smartthings_resource_connection_status_e status, void *user_data);

typedef void (*smartthings_resource_request_cb)(smartthings_resource_h st_h, int req_id, const char *uri,
                                                smartthings_resource_req_type_e req_type,
                                                smartthings_payload_h payload, void *user_data);

typedef void (*smartthings_resource_cloud_registration_status_cb)(smartthings_resource_h st_h, bool is_registered, void *user_data);


int smartthings_resource_initialize(smartthings_resource_h *st_h,
                                   smartthings_resource_connection_status_cb connection_status_cb,
                                   void *user_data);

int smartthings_resource_deinitialize(smartthings_resource_h st_h);

int smartthings_resource_set_request_cb(smartthings_resource_h st_h,
                                smartthings_resource_request_cb req_cb,
                                void *user_data);

int smartthings_resource_unset_request_cb(smartthings_resource_h st_h);

int smartthings_resource_send_response(smartthings_resource_h st_h, int req_id, const char *uri, smartthings_payload_h payload, bool result);

int smartthings_resource_notify(smartthings_resource_h st_h, const char *uri, smartthings_payload_h payload);

int smartthings_resource_get_uris(smartthings_resource_h st_h, int *count, char ***uris);

int smartthings_resource_set_cloud_registration_status_cb(smartthings_resource_h st_h,
                                smartthings_resource_cloud_registration_status_cb reg_cb,
                                void *user_data);

int smartthings_resource_unset_cloud_registration_status_cb(smartthings_resource_h st_h);


#ifdef __cplusplus
}
#endif

#endif /* __SAMSUNG_EXPERIENCE_SERVICE_SMARTTHINGS_RESOURCE_H__ */