room.h

[詳解]

//
// © NTT DOCOMO BUSINESS, Inc. All Rights Reserved.
//
 
#pragma once
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
 
#include "member.h"
#include "publication.h"
#include "subscription.h"
 

#define SKW_ROOM_ID_SIZE (36+1)
#define SKW_ROOM_NAME_SIZE (128+1)
#define SKW_ROOM_METADATA_SIZE (1024+1)

#define SKW_ROOM_REMOTE_MEMBER_COUNT (2)

#define SKW_ROOM_PERSON_COUNT (1 + SKW_ROOM_REMOTE_MEMBER_COUNT)

#define SKW_ROOM_BOT_COUNT (1)

#define SKW_ROOM_DATA_PUBLICATION_COUNT (2)

#define SKW_ROOM_DATA_SUBSCRIPTION_COUNT (2)

#define SKW_ROOM_MEMBER_DATA_COUNT (2)

#define SKW_ROOM_MEMBER_PUBLICATION_COUNT (1 + 1 + SKW_ROOM_MEMBER_DATA_COUNT)

#define SKW_ROOM_CAPACITY_MEMBERS (SKW_ROOM_PERSON_COUNT + SKW_ROOM_BOT_COUNT)
#define SKW_ROOM_CAPACITY_PUBLICATIONS (SKW_ROOM_PERSON_COUNT * SKW_ROOM_MEMBER_PUBLICATION_COUNT)
#define SKW_ROOM_CAPACITY_SUBSCRIPTIONS (SKW_ROOM_PERSON_COUNT * SKW_ROOM_REMOTE_MEMBER_COUNT * SKW_ROOM_MEMBER_PUBLICATION_COUNT)

#define SKW_ROOM_JOIN_TTL_SEC_DEFAULT (30U)

typedef enum {
    SKW_ROOM_OK                          = 0,   
    SKW_ROOM_ERR_NULL_ARGS               = 1,   
    SKW_ROOM_ERR_INVALID_ARGS            = 2,   
    SKW_ROOM_ERR_CONTEXT_NOT_INITED      = 3,   
    SKW_ROOM_ERR_CONTEXT_NOT_SETUP       = 4,   
    SKW_ROOM_ERR_REQUEST_FAILED          = 5,   
    SKW_ROOM_ERR_MUTEX_UNLOCK_FAILED     = 6,   
    SKW_ROOM_ERR_CALLED_IN_HANDLER       = 7,   
    SKW_ROOM_ERR_CAPACITY_EXHAUSTED      = 8,   
    SKW_ROOM_ERR_SEND_FAILED             = 9,   
    SKW_ROOM_ERR_TIMEOUT                 = 10,  
    SKW_ROOM_ERR_CONNECTION_CLOSED       = 11,  
    SKW_ROOM_ERR_RESPONSE_TOO_LARGE      = 12,  
    SKW_ROOM_ERR_RESPONSE_PARSE_FAILED   = 13,  
    SKW_ROOM_ERR_CONNECTION_FAILED       = 14,  
    SKW_ROOM_ERR_ALREADY_JOINED          = 15,  
    SKW_ROOM_ERR_UNKNOWN                 = 99,  
    SKW_ROOM_ERR_BAD_REQUEST             = 400, 
    SKW_ROOM_ERR_UNAUTHORIZED            = 401, 
    SKW_ROOM_ERR_FORBIDDEN               = 403, 
    SKW_ROOM_ERR_NOT_FOUND               = 404, 
    SKW_ROOM_ERR_ALREADY_EXIST           = 409, 
    SKW_ROOM_ERR_TOO_LARGE               = 413, 
    SKW_ROOM_ERR_TOO_MANY_REQUESTS       = 429, 
    SKW_ROOM_ERR_SERVER_INTERNAL         = 500, 
    SKW_ROOM_ERR_SERVER_BUSY             = 503, 
} skw_room_err_t;

typedef char skw_room_id_t[SKW_ROOM_ID_SIZE];
typedef char skw_room_name_t[SKW_ROOM_NAME_SIZE];
typedef char skw_room_metadata_t[SKW_ROOM_METADATA_SIZE];
typedef skw_room_member_data_field_t skw_room_member_data_fields_t[SKW_ROOM_CAPACITY_MEMBERS];
typedef skw_room_publication_data_field_t skw_room_publication_data_fields_t[SKW_ROOM_CAPACITY_PUBLICATIONS];
typedef skw_room_subscription_data_field_t skw_room_subscription_data_fields_t[SKW_ROOM_CAPACITY_SUBSCRIPTIONS];
typedef uint32_t skw_room_capacity_exhaustion_flags_t;
#define SKW_ROOM_CAPACITY_EXHAUSTED_MEMBERS       (1u << 0)
#define SKW_ROOM_CAPACITY_EXHAUSTED_PUBLICATIONS  (1u << 1)
#define SKW_ROOM_CAPACITY_EXHAUSTED_SUBSCRIPTIONS (1u << 2)

typedef struct {
    skw_room_id_t                       *id;                 
    skw_room_name_t                     *name;               
    skw_room_metadata_t                 *metadata;           
    skw_room_member_data_fields_t       *members;            
    uint32_t                            *member_count;       
    skw_room_publication_data_fields_t  *publications;       
    uint32_t                            *publication_count;  
    skw_room_subscription_data_fields_t *subscriptions;      
    uint32_t                            *subscription_count; 
    skw_room_capacity_exhaustion_flags_t *exhaustion_flags;  
} skw_room_data_field_t;

typedef void (*skw_room_on_room_closed_t)(const char* room_id);

typedef void (*skw_room_on_room_metadata_updated_t)(const char* room_id, const char* metadata);

typedef void (*skw_room_on_member_joined_t)(const char* room_id, const char* member_id);

typedef void (*skw_room_on_member_left_t)(const char* room_id, const char* member_id);

typedef void (*skw_room_on_member_metadata_updated_t)(const char* room_id, const char* member_id, const char* metadata);

typedef void (*skw_room_on_stream_published_t)(const char* room_id, const char* publication_id, const char* publisher_id,
                                               skw_room_publication_content_type_t content_type);

typedef void (*skw_room_on_stream_unpublished_t)(const char* room_id, const char* publication_id, const char* publisher_id);

typedef void (*skw_room_on_publication_subscribed_t)(const char* room_id, const char* subscription_id, const char* member_id);

typedef void (*skw_room_on_publication_unsubscribed_t)(const char* room_id, const char* subscription_id, const char* member_id);

typedef void (*skw_room_on_publication_metadata_updated_t)(const char* room_id, const char* publication_id, const char* metadata);

typedef struct skw_room_handlers_t {
    skw_room_on_room_closed_t on_room_closed;                                   
    skw_room_on_room_metadata_updated_t on_room_metadata_updated;               
    skw_room_on_member_joined_t on_member_joined;                               
    skw_room_on_member_left_t on_member_left;                                   
    skw_room_on_member_metadata_updated_t on_member_metadata_updated;           
    skw_room_on_stream_published_t on_stream_published;                         
    skw_room_on_stream_unpublished_t on_stream_unpublished;                     
    skw_room_on_publication_subscribed_t on_publication_subscribed;             
    skw_room_on_publication_unsubscribed_t on_publication_unsubscribed;         
    skw_room_on_publication_metadata_updated_t on_publication_metadata_updated; 
} skw_room_handlers_t;

typedef struct {
    const char* name;     
    const char* metadata; 
} skw_room_create_params_t;

#define SKW_ROOM_CREATE_PARAMS_INIT(...) {__VA_ARGS__}

typedef struct {
    const char* id; 
} skw_room_find_by_id_params_t;

#define SKW_ROOM_FIND_BY_ID_PARAMS_INIT(...) {__VA_ARGS__}

typedef struct {
    const char* name; 
} skw_room_find_by_name_params_t;

#define SKW_ROOM_FIND_BY_NAME_PARAMS_INIT(...) {__VA_ARGS__}

typedef struct {
    const char* name;     
    const char* metadata; 
} skw_room_find_or_create_params_t;

#define SKW_ROOM_FIND_OR_CREATE_PARAMS_INIT(...) {__VA_ARGS__}

typedef struct {
    const char* id;       
    const char* metadata; 
} skw_room_update_metadata_params_t;

#define SKW_ROOM_UPDATE_METADATA_PARAMS_INIT(...) {__VA_ARGS__}

typedef struct {
    const char* id;       
    const char* name;     
    const char* metadata; 
    uint32_t ttl_sec;     
} skw_room_join_params_t;

#define SKW_ROOM_JOIN_PARAMS_INIT(...) {__VA_ARGS__}

skw_room_err_t skw_room_create(const skw_room_create_params_t* params, skw_room_data_field_t* data_fields);

skw_room_err_t skw_room_find_by_id(const skw_room_find_by_id_params_t* params, skw_room_data_field_t* data_fields);

skw_room_err_t skw_room_find_by_name(const skw_room_find_by_name_params_t* params, skw_room_data_field_t* data_fields);

skw_room_err_t skw_room_find_or_create(const skw_room_find_or_create_params_t* params, skw_room_data_field_t* data_fields);

skw_room_err_t skw_room_join(const skw_room_join_params_t* params, skw_room_member_data_field_t* data_fields);

skw_room_err_t skw_room_update_metadata(const skw_room_update_metadata_params_t* params);

skw_room_err_t skw_room_register_handlers(const skw_room_handlers_t* handlers);

skw_room_err_t skw_room_unregister_handlers(void);
 
#ifdef __cplusplus
}
#endif