[279] | 1 | /*
|
---|
| 2 | * TOPPERS WEBSOCKET Lite Communication Middleware
|
---|
| 3 | *
|
---|
| 4 | * Copyright (C) 2017 Cores Co., Ltd. Japan
|
---|
| 5 | *
|
---|
| 6 | * ä¸è¨èä½æ¨©è
|
---|
| 7 | ã¯ï¼ä»¥ä¸ã®(1)ï½(4)ã®æ¡ä»¶ãæºããå ´åã«éãï¼æ¬ã½ããã¦ã§
|
---|
| 8 | * ã¢ï¼æ¬ã½ããã¦ã§ã¢ãæ¹å¤ãããã®ãå«ãï¼ä»¥ä¸åãï¼ã使ç¨ã»è¤è£½ã»æ¹
|
---|
| 9 | * å¤ã»åé
|
---|
| 10 | å¸ï¼ä»¥ä¸ï¼å©ç¨ã¨å¼ã¶ï¼ãããã¨ãç¡åã§è¨±è«¾ããï¼
|
---|
| 11 | * (1) æ¬ã½ããã¦ã§ã¢ãã½ã¼ã¹ã³ã¼ãã®å½¢ã§å©ç¨ããå ´åã«ã¯ï¼ä¸è¨ã®èä½
|
---|
| 12 | * 権表示ï¼ãã®å©ç¨æ¡ä»¶ããã³ä¸è¨ã®ç¡ä¿è¨¼è¦å®ãï¼ãã®ã¾ã¾ã®å½¢ã§ã½ã¼
|
---|
| 13 | * ã¹ã³ã¼ãä¸ã«å«ã¾ãã¦ãããã¨ï¼
|
---|
| 14 | * (2) æ¬ã½ããã¦ã§ã¢ãï¼ã©ã¤ãã©ãªå½¢å¼ãªã©ï¼ä»ã®ã½ããã¦ã§ã¢éçºã«ä½¿
|
---|
| 15 | * ç¨ã§ããå½¢ã§åé
|
---|
| 16 | å¸ããå ´åã«ã¯ï¼åé
|
---|
| 17 | å¸ã«ä¼´ãããã¥ã¡ã³ãï¼å©ç¨
|
---|
| 18 | * è
|
---|
| 19 | ããã¥ã¢ã«ãªã©ï¼ã«ï¼ä¸è¨ã®èä½æ¨©è¡¨ç¤ºï¼ãã®å©ç¨æ¡ä»¶ããã³ä¸è¨
|
---|
| 20 | * ã®ç¡ä¿è¨¼è¦å®ãæ²è¼ãããã¨ï¼
|
---|
| 21 | * (3) æ¬ã½ããã¦ã§ã¢ãï¼æ©å¨ã«çµã¿è¾¼ããªã©ï¼ä»ã®ã½ããã¦ã§ã¢éçºã«ä½¿
|
---|
| 22 | * ç¨ã§ããªãå½¢ã§åé
|
---|
| 23 | å¸ããå ´åã«ã¯ï¼æ¬¡ã®ããããã®æ¡ä»¶ãæºããã
|
---|
| 24 | * ã¨ï¼
|
---|
| 25 | * (a) åé
|
---|
| 26 | å¸ã«ä¼´ãããã¥ã¡ã³ãï¼å©ç¨è
|
---|
| 27 | ããã¥ã¢ã«ãªã©ï¼ã«ï¼ä¸è¨ã®è
|
---|
| 28 | * ä½æ¨©è¡¨ç¤ºï¼ãã®å©ç¨æ¡ä»¶ããã³ä¸è¨ã®ç¡ä¿è¨¼è¦å®ãæ²è¼ãããã¨ï¼
|
---|
| 29 | * (b) åé
|
---|
| 30 | å¸ã®å½¢æ
|
---|
| 31 | ãï¼å¥ã«å®ããæ¹æ³ã«ãã£ã¦ï¼TOPPERSããã¸ã§ã¯ãã«
|
---|
| 32 | * å ±åãããã¨ï¼
|
---|
| 33 | * (4) æ¬ã½ããã¦ã§ã¢ã®å©ç¨ã«ããç´æ¥çã¾ãã¯éæ¥çã«çãããããªãæ
|
---|
| 34 | * 害ãããï¼ä¸è¨èä½æ¨©è
|
---|
| 35 | ããã³TOPPERSããã¸ã§ã¯ããå
|
---|
| 36 | 責ãããã¨ï¼
|
---|
| 37 | * ã¾ãï¼æ¬ã½ããã¦ã§ã¢ã®ã¦ã¼ã¶ã¾ãã¯ã¨ã³ãã¦ã¼ã¶ããã®ãããªãç
|
---|
| 38 | * ç±ã«åºã¥ãè«æ±ãããï¼ä¸è¨èä½æ¨©è
|
---|
| 39 | ããã³TOPPERSããã¸ã§ã¯ãã
|
---|
| 40 | * å
|
---|
| 41 | 責ãããã¨ï¼
|
---|
| 42 | *
|
---|
| 43 | * æ¬ã½ããã¦ã§ã¢ã¯ï¼ç¡ä¿è¨¼ã§æä¾ããã¦ãããã®ã§ããï¼ä¸è¨èä½æ¨©è
|
---|
| 44 | ã
|
---|
| 45 | * ãã³TOPPERSããã¸ã§ã¯ãã¯ï¼æ¬ã½ããã¦ã§ã¢ã«é¢ãã¦ï¼ç¹å®ã®ä½¿ç¨ç®ç
|
---|
| 46 | * ã«å¯¾ããé©åæ§ãå«ãã¦ï¼ãããªãä¿è¨¼ãè¡ããªãï¼ã¾ãï¼æ¬ã½ããã¦ã§
|
---|
| 47 | * ã¢ã®å©ç¨ã«ããç´æ¥çã¾ãã¯éæ¥çã«çãããããªãæ害ã«é¢ãã¦ãï¼ã
|
---|
| 48 | * ã®è²¬ä»»ãè² ããªãï¼
|
---|
| 49 | *
|
---|
| 50 | * @(#) $Id: websocket_fbs.h 279 2017-04-29 07:33:37Z coas-nagasima $
|
---|
| 51 | */
|
---|
| 52 |
|
---|
| 53 | /*
|
---|
| 54 | * åºå®é·ãããã¡å¯å¤é·ã¹ããªã¼ã
|
---|
| 55 | */
|
---|
| 56 |
|
---|
| 57 | #ifndef _WEBSOCKET_FBS_H_
|
---|
| 58 | #define _WEBSOCKET_FBS_H_
|
---|
| 59 |
|
---|
| 60 | #include <kernel.h>
|
---|
| 61 |
|
---|
| 62 | #ifdef __cplusplus
|
---|
| 63 | extern "C" {
|
---|
| 64 | #endif
|
---|
| 65 |
|
---|
| 66 | #ifndef WEBSOCKET_MEMPOOL_GET_TMO
|
---|
| 67 | #define WEBSOCKET_MEMPOOL_GET_TMO (0) /* ã¡ã¢ãªãã¼ã«åå¾æã®ã¿ã¤ã ã¢ã¦ãæå® */
|
---|
| 68 | #endif /* WEBSOCKET_MEMPOOL_GET_TMO */
|
---|
| 69 |
|
---|
| 70 | #ifndef NUM_WEBSOCKET_MEMPOOL_BLOCK
|
---|
| 71 | #define NUM_WEBSOCKET_MEMPOOL_BLOCK (60) /* é»æç¨ã¡ã¢ãªãããã¯ã®æ° */
|
---|
| 72 | #endif /* NUM_WEBSOCKET_MEMPOOL_BLOCK */
|
---|
| 73 |
|
---|
| 74 | #ifndef WEBSOCKET_MEMPOOL_BLOCK_SIZE
|
---|
| 75 | #define WEBSOCKET_MEMPOOL_BLOCK_SIZE (256) /* é»æç¨ã¡ã¢ãªãããã¯ã®ãµã¤ãº */
|
---|
| 76 | #endif /* WEBSOCKET_MEMPOOL_BLOCK_SIZE */
|
---|
| 77 |
|
---|
| 78 | typedef unsigned int WS_FBS_SIZE_T; /* size_tç¸å½ */
|
---|
| 79 | typedef int WS_FBS_SSIZE_T; /* ssize_tç¸å½ */
|
---|
| 80 |
|
---|
| 81 | /* T_WS_FST_BLK管çé åãµã¤ãº */
|
---|
| 82 | #define DEF_WS_EDT_HDR_LEN (sizeof(intptr_t))
|
---|
| 83 |
|
---|
| 84 | /* 管çé åãµã¤ãº(64byte - sizeof(T_MSG)) */
|
---|
| 85 | /* #define DEF_WS_FBS_LIB_HDR_LEN ((WEBSOCKET_MEMPOOL_BLOCK_SIZE + sizeof(int) - 1)>> 2) // */
|
---|
| 86 | #define DEF_WS_FBS_LIB_HDR_LEN (64 - DEF_WS_EDT_HDR_LEN)
|
---|
| 87 |
|
---|
| 88 | /* 管çé åãå«ããããã¯ã«ä¿æãããã¼ã¿ãµã¤ãº */
|
---|
| 89 | #define DEF_WS_FBS_FST_DAT_LEN (64)
|
---|
| 90 |
|
---|
| 91 | /* ãªã³ã¯ãã¤ã³ã¿é
|
---|
| 92 | åã®ãµã¤ãº(byte) */
|
---|
| 93 | #define DEF_WS_FBS_LNK_LEN (WEBSOCKET_MEMPOOL_BLOCK_SIZE - DEF_WS_EDT_HDR_LEN - DEF_WS_FBS_LIB_HDR_LEN - DEF_WS_FBS_FST_DAT_LEN)
|
---|
| 94 |
|
---|
| 95 | /* åºå®é·ãããã¡æ大ãµã¤ãº */
|
---|
| 96 | #define DEF_WS_FBS_BUF_MAXLEN ((DEF_WS_FBS_LNK_LEN / sizeof(void *)) * WEBSOCKET_MEMPOOL_BLOCK_SIZE + DEF_WS_FBS_FST_DAT_LEN)
|
---|
| 97 |
|
---|
| 98 | /* åè¦ç´ ãããã¡ã®ãµã¤ãº */
|
---|
| 99 | #define DEF_WS_FBS_SUB_BUF_LEN WEBSOCKET_MEMPOOL_BLOCK_SIZE
|
---|
| 100 |
|
---|
| 101 | /* é»æã®ç¨®å¥(å
|
---|
| 102 | 容ã¯ä»®) */
|
---|
| 103 | typedef enum
|
---|
| 104 | {
|
---|
| 105 | WS_FBS_TYPE_BLANK = 0, /* æªä½¿ç¨ã¹ããªã¼ã */
|
---|
| 106 | WS_FBS_TYPE_INTERNAL = 1, /* å
|
---|
| 107 | é¨ã¡ãã»ã¼ã¸ */
|
---|
| 108 | WS_FBS_TYPE_WEBSOCKET = 2 /* WEBSOCKETé»æ */
|
---|
| 109 | } TA_WS_MSG_TYPE;
|
---|
| 110 |
|
---|
| 111 | /* ãªã³ã¯ãã¤ã³ã¿é
|
---|
| 112 | åã«åæããããåè¦ç´ ãããã¡ */
|
---|
| 113 | typedef struct
|
---|
| 114 | {
|
---|
| 115 | uint8_t payload[WEBSOCKET_MEMPOOL_BLOCK_SIZE];
|
---|
| 116 | } T_WS_SUB_BLK;
|
---|
| 117 |
|
---|
| 118 | /* ãªã³ã¯ãã¤ã³ã¿é
|
---|
| 119 | å */
|
---|
| 120 | typedef union
|
---|
| 121 | {
|
---|
| 122 | T_WS_SUB_BLK *p_sub[DEF_WS_FBS_LNK_LEN / sizeof(T_WS_SUB_BLK *)];
|
---|
| 123 | uint8_t bin[DEF_WS_FBS_LNK_LEN];
|
---|
| 124 | } T_WS_FBS_LNK;
|
---|
| 125 |
|
---|
| 126 | /* 管çé å(64byte - sizeof(T_MSG)) */
|
---|
| 127 | typedef struct
|
---|
| 128 | {
|
---|
| 129 | uint16_t length; /* ã¡ãã»ã¼ã¸é· */
|
---|
| 130 | uint16_t type; /* ã¡ãã»ã¼ã¸ã¿ã¤ã */
|
---|
| 131 | union{
|
---|
| 132 | ID mbxid; /* éä¿¡å
|
---|
| 133 | ã¡ã¼ã«ããã¯ã¹IDï¼å
|
---|
| 134 | é¨ã¡ãã»ã¼ã¸ï¼ */
|
---|
| 135 | }sender;
|
---|
| 136 | union{
|
---|
| 137 | ID mbxid; /* éä¿¡å
|
---|
| 138 | ã¡ã¼ã«ããã¯ã¹IDï¼å
|
---|
| 139 | é¨ã¡ãã»ã¼ã¸ï¼ */
|
---|
| 140 | }target;
|
---|
| 141 | union{
|
---|
| 142 | ID mbxid; /* è¿ä¿¡å
|
---|
| 143 | ã¡ã¼ã«ããã¯ã¹IDï¼å
|
---|
| 144 | é¨ã¡ãã»ã¼ã¸ï¼ */
|
---|
| 145 | }reply;
|
---|
| 146 |
|
---|
| 147 | int rd; /* èªã¿åããããæ
|
---|
| 148 | å ± */
|
---|
| 149 | int wr; /* æ¸ãè¾¼ã¿ãããæ
|
---|
| 150 | å ± */
|
---|
| 151 | } T_WS_FBS_HDR;
|
---|
| 152 |
|
---|
| 153 | /* 管çé åãå«ããããã¯ã®æ§é */
|
---|
| 154 | typedef struct
|
---|
| 155 | {
|
---|
| 156 | uint8_t _msg[DEF_WS_EDT_HDR_LEN]; /* T_MSG */
|
---|
| 157 | T_WS_FBS_HDR hdr; /* 管çé å 64byte - sizeof(T_MSG) */
|
---|
| 158 | uint8_t _gap[DEF_WS_FBS_LIB_HDR_LEN - sizeof(T_WS_FBS_HDR)];
|
---|
| 159 | T_WS_FBS_LNK lnk; /* ãªã³ã¯ãã¤ã³ã¿é
|
---|
| 160 | å 128byte */
|
---|
| 161 | uint8_t payload[DEF_WS_FBS_FST_DAT_LEN];
|
---|
| 162 | } T_WS_FST_BLK;
|
---|
| 163 |
|
---|
| 164 | /* FBS-ID */
|
---|
| 165 | typedef struct ws_fbs_id_strc
|
---|
| 166 | {
|
---|
| 167 | T_WS_FST_BLK *ptr;
|
---|
| 168 | } WS_FBS_ID;
|
---|
| 169 |
|
---|
| 170 | /* ã¡ãã»ã¼ã¸ãã¥ã¼ */
|
---|
| 171 | typedef struct ws_fbs_queue
|
---|
| 172 | {
|
---|
| 173 | T_WS_FST_BLK *pk_head; /* å
|
---|
| 174 | é ã®ã¡ãã»ã¼ã¸ */
|
---|
| 175 | T_WS_FST_BLK *pk_last; /* æ«å°¾ã®ã¡ãã»ã¼ã¸ */
|
---|
| 176 | } T_WS_FBS_QUEUE;
|
---|
| 177 |
|
---|
| 178 | extern ID ws_mempoolid;
|
---|
| 179 |
|
---|
| 180 | /* ã¡ã¢ãªãããã¯åå¾ ok:ãã¤ã³ã¿ NG:NULL */
|
---|
| 181 | void *_ws_fbs_mbx_get(WS_FBS_SIZE_T fa_req_size);
|
---|
| 182 |
|
---|
| 183 | /* ã¡ã¢ãªãããã¯è§£æ¾ ok:0 NG:é0 */
|
---|
| 184 | ER _ws_fbs_mbx_rel(void *p);
|
---|
| 185 |
|
---|
| 186 | /*
|
---|
| 187 | * é å確ä¿
|
---|
| 188 | * å¼æ°
|
---|
| 189 | * WS_FBS_SIZE_T fa_req_size è¦æ±ãããã¡ãµã¤ãº(byte)
|
---|
| 190 | * max: DEF_WS_FBS_BUF_MAXLEN
|
---|
| 191 | * WS_FBS_ID *fp_id 確ä¿ããFBS-IDã®æ ¼ç´å
|
---|
| 192 |
|
---|
| 193 | * æ»ãå¤
|
---|
| 194 | * ER 0:ok é0:NG
|
---|
| 195 | */
|
---|
| 196 | ER _ws_fbs_cre(WS_FBS_SIZE_T fa_req_size, WS_FBS_ID *fp_id);
|
---|
| 197 |
|
---|
| 198 | /*
|
---|
| 199 | * é å解æ¾
|
---|
| 200 | * å¼æ°
|
---|
| 201 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 202 | * æ»ãå¤
|
---|
| 203 | * ER 0:ok, é0:NG
|
---|
| 204 | */
|
---|
| 205 | ER _ws_fbs_del(WS_FBS_ID fa_id);
|
---|
| 206 |
|
---|
| 207 | /*
|
---|
| 208 | * ä¿æãã¼ã¿ã®æç¡
|
---|
| 209 | * å¼æ°
|
---|
| 210 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 211 | * æ»ãå¤
|
---|
| 212 | * bool_t 0:ç¡ã, 1:ãã
|
---|
| 213 | */
|
---|
| 214 | bool_t _ws_fbs_exist_data(WS_FBS_ID fa_id);
|
---|
| 215 |
|
---|
| 216 | /*
|
---|
| 217 | * ä¿æãã¼ã¿é·ã®åå¾
|
---|
| 218 | * å¼æ°
|
---|
| 219 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 220 | * æ»ãå¤
|
---|
| 221 | * WS_FBS_SSIZE_T ä¿æãã¦ãããã¼ã¿ã®é·ã(byte) -1:NG
|
---|
| 222 | */
|
---|
| 223 | WS_FBS_SSIZE_T _ws_fbs_get_datalen(WS_FBS_ID fa_id);
|
---|
| 224 |
|
---|
| 225 | /*
|
---|
| 226 | * èªã¿åãã«ã¼ã½ã«ã®ä½ç½®åå¾
|
---|
| 227 | * å¼æ°
|
---|
| 228 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 229 | * æ»ãå¤
|
---|
| 230 | * WS_FBS_SIZE_T å
|
---|
| 231 | é ããã®çµ¶å¯¾ä½ç½® -1:NG
|
---|
| 232 | */
|
---|
| 233 | WS_FBS_SSIZE_T _ws_fbs_get_rpos(WS_FBS_ID fa_id);
|
---|
| 234 |
|
---|
| 235 | /*
|
---|
| 236 | * èªã¿åãã«ã¼ã½ã«ã®ä½ç½®è¨å®
|
---|
| 237 | * å¼æ°
|
---|
| 238 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 239 | * WS_FBS_SIZE_T fa_pos è¨å®ããä½ç½®(å
|
---|
| 240 | é ããã®çµ¶å¯¾ä½ç½®)
|
---|
| 241 | * æ»ãå¤
|
---|
| 242 | * ER 0:ok, é0:NG
|
---|
| 243 | */
|
---|
| 244 | ER _ws_fbs_set_rpos(WS_FBS_ID fa_id, WS_FBS_SSIZE_T fa_pos);
|
---|
| 245 |
|
---|
| 246 | /*
|
---|
| 247 | * èªã¿åãã«ã¼ã½ã«ã®ä½ç½®ç§»å
|
---|
| 248 | * å¼æ°
|
---|
| 249 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 250 | * WS_FBS_SIZE_T fa_seek 移åé(ç¾ç¶ãåé²ã®ã¿)
|
---|
| 251 | * æ»ãå¤
|
---|
| 252 | * ER 0:ok, é0:NG
|
---|
| 253 | */
|
---|
| 254 | ER _ws_fbs_seek_rpos(WS_FBS_ID fa_id, WS_FBS_SSIZE_T fa_seek);
|
---|
| 255 |
|
---|
| 256 | /*
|
---|
| 257 | * ä»»ææå®ä½ç½®ã®1byteèªã¿åã
|
---|
| 258 | */
|
---|
| 259 | int _ws_fbs_peek(WS_FBS_ID fa_id, WS_FBS_SSIZE_T fa_seek);
|
---|
| 260 |
|
---|
| 261 | /*
|
---|
| 262 | * ä»»ææå®ä½ç½®ã®1byteæ¸ãè¾¼ã¿
|
---|
| 263 | */
|
---|
| 264 | ER _ws_fbs_poke(WS_FBS_ID fa_id, WS_FBS_SSIZE_T fa_seek, int fa_val);
|
---|
| 265 |
|
---|
| 266 | /*
|
---|
| 267 | * ãã¼ã¿è¿½å
|
---|
| 268 | * å¼æ°
|
---|
| 269 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 270 | * const void * fa_dat 追å ãããã¼ã¿
|
---|
| 271 | * WS_FBS_SSIZE_T fa_len 追å ããé·ã(byte)
|
---|
| 272 | * æ»ãå¤
|
---|
| 273 | * ER 0:ok, é0:NG
|
---|
| 274 | */
|
---|
| 275 | ER _ws_fbs_add_data(WS_FBS_ID fa_id, const void *fa_dat, WS_FBS_SSIZE_T fa_len);
|
---|
| 276 |
|
---|
| 277 | /*
|
---|
| 278 | * ãã¼ã¿è¿½å (é åãèªåçã«æ¡å¼µãã)
|
---|
| 279 | * å¼æ°
|
---|
| 280 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 281 | * const void * fa_dat 追å ãããã¼ã¿
|
---|
| 282 | * WS_FBS_SSIZE_T fa_len 追å ããé·ã(byte)
|
---|
| 283 | * æ»ãå¤
|
---|
| 284 | * ER 0:ok, é0:NG
|
---|
| 285 | */
|
---|
| 286 | ER _ws_fbs_add_data_ex(WS_FBS_ID fa_id, const void *fa_dat, WS_FBS_SSIZE_T fa_len);
|
---|
| 287 |
|
---|
| 288 | /*
|
---|
| 289 | * ãã¼ã¿åå¾
|
---|
| 290 | * å¼æ°
|
---|
| 291 | * ws_fbs_idå 確ä¿ããFBS-ID
|
---|
| 292 | * void * fa_buf åå¾ãããããã¡
|
---|
| 293 | * WS_FBS_SSIZE_T fa_maxlen åå¾ããé·ã(byte)
|
---|
| 294 | * WS_FBS_SSIZE_T *p_len åå¾ããé·ã(byte)
|
---|
| 295 | * æ»ãå¤
|
---|
| 296 | * ER 0:ok, é0:NG
|
---|
| 297 | */
|
---|
| 298 | ER _ws_fbs_get_data(WS_FBS_ID fa_id, void *fa_buf, WS_FBS_SSIZE_T fa_maxlen,
|
---|
| 299 | WS_FBS_SSIZE_T *p_len);
|
---|
| 300 |
|
---|
| 301 | ER ws_fbs_enqueue(T_WS_FBS_QUEUE *pk_queue, T_WS_FST_BLK *pk_buf);
|
---|
| 302 | ER ws_fbs_dequeue(T_WS_FBS_QUEUE *pk_queue, T_WS_FST_BLK **ppk_buf);
|
---|
| 303 |
|
---|
| 304 | #ifdef __cplusplus
|
---|
| 305 | } /* extern "C" */
|
---|
| 306 | #endif
|
---|
| 307 |
|
---|
| 308 | #endif /* #ifndef _WEBSOCKET_FBS_H_ */
|
---|