coap_event.h

Go to the documentation of this file.

/*
 * coap_event.h -- libcoap Event API
 *
 * Copyright (C) 2016 Olaf Bergmann <bergmann@tzi.org>
 * Copyright (C) 2021-2024 Jon Shallow <supjps-libcoap@jpshallow.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_EVENT_H_
#define COAP_EVENT_H_
 
#include "libcoap.h"
 
typedef enum {
  /*
   * (D)TLS events for COAP_PROTO_DTLS and COAP_PROTO_TLS
   */
  COAP_EVENT_DTLS_CLOSED       = 0x0000,
  COAP_EVENT_DTLS_CONNECTED    = 0x01DE,
  COAP_EVENT_DTLS_RENEGOTIATE  = 0x01DF,
  COAP_EVENT_DTLS_ERROR        = 0x0200,
 
  /*
   * TCP events for COAP_PROTO_TCP and COAP_PROTO_TLS
   */
  COAP_EVENT_TCP_CONNECTED     = 0x1001,
  COAP_EVENT_TCP_CLOSED        = 0x1002,
  COAP_EVENT_TCP_FAILED        = 0x1003,
 
  /*
   * CSM exchange events for reliable protocols only
   */
  COAP_EVENT_SESSION_CONNECTED = 0x2001,
  COAP_EVENT_SESSION_CLOSED    = 0x2002,
  COAP_EVENT_SESSION_FAILED    = 0x2003,
 
  /*
   * (Q-)Block errors
   */
  COAP_EVENT_PARTIAL_BLOCK     = 0x3001,
  COAP_EVENT_XMIT_BLOCK_FAIL   = 0x3002,
 
  /*
   * Server session events
   */
  COAP_EVENT_SERVER_SESSION_NEW = 0x4001,
 
  COAP_EVENT_SERVER_SESSION_DEL = 0x4002,
 
  /*
   * Message receive and transmit events
   */
  COAP_EVENT_BAD_PACKET         = 0x5001,
  COAP_EVENT_MSG_RETRANSMITTED  = 0x5002,
 
  /*
   * OSCORE events
   */
  COAP_EVENT_OSCORE_DECRYPTION_FAILURE = 0x6001,
  COAP_EVENT_OSCORE_NOT_ENABLED,
  COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD,
  COAP_EVENT_OSCORE_NO_SECURITY,
  COAP_EVENT_OSCORE_INTERNAL_ERROR,
  COAP_EVENT_OSCORE_DECODE_ERROR,
  /*
   * WebSocket events
   */
  COAP_EVENT_WS_PACKET_SIZE = 0x7001,
  COAP_EVENT_WS_CONNECTED,
  COAP_EVENT_WS_CLOSED,
  /*
   * Keepalive events
   */
  COAP_EVENT_KEEPALIVE_FAILURE = 0x8001,
} coap_event_t;
 
typedef int (*coap_event_handler_t)(coap_session_t *session,
                                    const coap_event_t event);
 
void coap_register_event_handler(coap_context_t *context,
                                 coap_event_handler_t hnd);
 
COAP_DEPRECATED
void coap_set_event_handler(coap_context_t *context,
                            coap_event_handler_t hnd);
 
COAP_DEPRECATED
void coap_clear_event_handler(coap_context_t *context);
 
#endif /* COAP_EVENT_H */