src/afb-ws.h

   1 /*
   2  * Copyright (C) 2015-2020 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 struct afb_ws;
  21 struct fdev;
  22 struct iovec;
  23
  24 struct afb_ws_itf
  25 {
  26         void (*on_close) (void *, uint16_t code, char *, size_t size); /* optional, if not set hangup is called */
  27         void (*on_text) (void *, char *, size_t size);
  28         void (*on_binary) (void *, char *, size_t size);
  29         void (*on_error) (void *, uint16_t code, const void *, size_t size); /* optional, if not set hangup is called */
  30         void (*on_hangup) (void *); /* optional, it is safe too call afb_ws_destroy within the callback */
  31 };
  32
  33 extern struct afb_ws *afb_ws_create(struct fdev *fdev, const struct afb_ws_itf *itf, void *closure);
  34 extern void afb_ws_destroy(struct afb_ws *ws);
  35 extern void afb_ws_hangup(struct afb_ws *ws);
  36 extern int afb_ws_is_connected(struct afb_ws *ws);
  37 extern int afb_ws_close(struct afb_ws *ws, uint16_t code, const char *reason);
  38 extern int afb_ws_error(struct afb_ws *ws, uint16_t code, const char *reason);
  39 extern int afb_ws_text(struct afb_ws *ws, const char *text, size_t length);
  40 extern int afb_ws_texts(struct afb_ws *ws, ...);
  41 extern int afb_ws_binary(struct afb_ws *ws, const void *data, size_t length);
  42 extern int afb_ws_text_v(struct afb_ws *ws, const struct iovec *iovec, int count);
  43 extern int afb_ws_binary_v(struct afb_ws *ws, const struct iovec *iovec, int count);
  44