File espos_sk_token_sm.h¶

FileList > espos_sk > include > espos_sk_token_sm.h

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "esp_err.h"

Classes¶

Type	Name
struct	espos_sk_http_result_t
struct	espos_sk_server_t
struct	espos_sk_tok_cfg_t
struct	espos_sk_tok_port_t
struct	espos_sk_tok_sm_t
struct	espos_sk_tok_status_t
struct	espos_sk_tok_store_t

Public Types¶

Type	Name
enum	espos_sk_tok_event_t
enum	espos_sk_tok_state_t

Public Functions¶

Type	Name
void	espos_sk_tok_event (espos_sk_tok_sm_t * sm, espos_sk_tok_event_t ev, const void * arg)
void	espos_sk_tok_init (espos_sk_tok_sm_t * sm, const espos_sk_tok_port_t * port, void * ctx, const espos_sk_tok_cfg_t * cfg, const espos_sk_tok_store_t * store)
const char *	espos_sk_tok_state_str (espos_sk_tok_state_t s)
const espos_sk_tok_status_t *	espos_sk_tok_status (const espos_sk_tok_sm_t * sm)
const char *	espos_sk_tok_token (const espos_sk_tok_sm_t * sm)

Macros¶

Type	Name
define	ESPOS_SK_HOST_MAX `64`
define	ESPOS_SK_HREF_MAX `128`
define	ESPOS_SK_MSG_MAX `96`
define	ESPOS_SK_SELF_MAX `128`
define	ESPOS_SK_TOKEN_MAX `1024`

Public Types Documentation¶

enum espos_sk_tok_event_t¶

enum espos_sk_tok_event_t {
    ESPOS_SK_EV_START,
    ESPOS_SK_EV_STOP,
    ESPOS_SK_EV_SERVER,
    ESPOS_SK_EV_REQUEST_RESULT,
    ESPOS_SK_EV_POLL_RESULT,
    ESPOS_SK_EV_VERIFY_RESULT,
    ESPOS_SK_EV_TIMER,
    ESPOS_SK_EV_MANUAL_TOKEN,
    ESPOS_SK_EV_RETRY,
    ESPOS_SK_EV_UNAUTHORIZED,
    ESPOS_SK_EV_CONFIG,
    ESPOS_SK_EV_CERT_ERROR
};

enum espos_sk_tok_state_t¶

enum espos_sk_tok_state_t {
    ESPOS_SK_TOK_NO_SERVER = 0,
    ESPOS_SK_TOK_IDLE,
    ESPOS_SK_TOK_REQUESTED,
    ESPOS_SK_TOK_VERIFYING,
    ESPOS_SK_TOK_APPROVED,
    ESPOS_SK_TOK_DENIED,
    ESPOS_SK_TOK_OPEN,
    ESPOS_SK_TOK_ERROR,
    ESPOS_SK_TOK_CERT_ERROR
};

Public Functions Documentation¶

function espos_sk_tok_event¶

void espos_sk_tok_event (
    espos_sk_tok_sm_t * sm,
    espos_sk_tok_event_t ev,
    const void * arg
)

function espos_sk_tok_init¶

void espos_sk_tok_init (
    espos_sk_tok_sm_t * sm,
    const espos_sk_tok_port_t * port,
    void * ctx,
    const espos_sk_tok_cfg_t * cfg,
    const espos_sk_tok_store_t * store
)

function espos_sk_tok_state_str¶

const char * espos_sk_tok_state_str (
    espos_sk_tok_state_t s
)

function espos_sk_tok_status¶

const espos_sk_tok_status_t * espos_sk_tok_status (
    const espos_sk_tok_sm_t * sm
)

function espos_sk_tok_token¶

const char * espos_sk_tok_token (
    const espos_sk_tok_sm_t * sm
)

Macro Definition Documentation¶

define ESPOS_SK_HOST_MAX¶

#define ESPOS_SK_HOST_MAX `64`

define ESPOS_SK_HREF_MAX¶

#define ESPOS_SK_HREF_MAX `128`

define ESPOS_SK_MSG_MAX¶

#define ESPOS_SK_MSG_MAX `96`

define ESPOS_SK_SELF_MAX¶

#define ESPOS_SK_SELF_MAX `128`

define ESPOS_SK_TOKEN_MAX¶

#define ESPOS_SK_TOKEN_MAX `1024`

The documentation for this class was generated from the following file espos_sk/include/espos_sk_token_sm.h