moqsess.h

Go to the documentation of this file.

#ifndef MOQSESS_H
#define MOQSESS_H
 
#include "common/platform/sys/syscall.h"

 
/* ===================== A. Session establishment ===================== */

typedef enum {
  MOQSESS_IDLE        = 0, /* neither SETUP sent nor peer's received */
  MOQSESS_SETUP_HALF  = 1, /* exactly one of (sent, peer recv'd) done */
  MOQSESS_ESTABLISHED = 2,
  MOQSESS_CLOSED      = 3,
} moqsess_state;

typedef enum {
  MOQSESS_EV_SENT_SETUP          = 0, /* own SETUP finished sending */
  MOQSESS_EV_RECV_SETUP          = 1, /* peer's SETUP received */
  MOQSESS_EV_CTRL_CLOSED         = 2, /* control stream closed at transport */
  MOQSESS_EV_UNKNOWN_UNI         = 3, /* unknown uni stream type byte */
  MOQSESS_EV_SECOND_CTRL         = 4, /* 2nd control stream from same peer */
  MOQSESS_EV_MALFORMED_CTRL      = 5, /* unknown msg type / len mismatch */
  MOQSESS_EV_SEND_GOAWAY         = 6,
  MOQSESS_EV_RECV_GOAWAY         = 7,
  MOQSESS_EV_RECV_GOAWAY_BAD_URI = 8,  /* server: nonzero URI length */
  MOQSESS_EV_GOAWAY_TIMEOUT      = 9,  /* peer did not close in time */
  MOQSESS_EV_BAD_FIRST           = 10, /* new request stream's head is not a
                                        * First-type message (codec-detected) */
  MOQSESS_EV_BAD_REQUEST_ID = 11,      /* wrong parity or a reused Request
                                        * ID (codec-detected) */
} moqsess_event;

#define MOQSESS_CLOSE_NONE 0
#define MOQSESS_CLOSE_PROTOCOL_VIOLATION 1
#define MOQSESS_CLOSE_INVALID_REQUEST_ID 2
#define MOQSESS_CLOSE_GOAWAY_TIMEOUT 3
#define MOQSESS_CLOSE_NO_ERROR 4

typedef struct {
  moqsess_state state;
  int goaway_sent;
  int goaway_recv;
  int close_reason;
} moqsess;

void moqsess_init(moqsess* s);

int moqsess_step(moqsess* s, moqsess_event ev);

int moqsess_should_buffer(const moqsess* s);

int moqsess_established(const moqsess* s);

int moqsess_may_reject_request(const moqsess* s);

int moqsess_suppress_own_requests(const moqsess* s);
 
/* ===================== B. Subscribe lifecycle ===================== */

typedef enum {
  MOQSUB_IDLE        = 0,
  MOQSUB_PENDING     = 1,
  MOQSUB_ESTABLISHED = 2,
  MOQSUB_TERMINATED  = 3,
} moqsub_state;

typedef enum {
  MOQSUB_ROLE_SUBSCRIBER = 0, /* sent/received SUBSCRIBE first */
  MOQSUB_ROLE_PUBLISHER  = 1, /* sent/received PUBLISH first */
} moqsub_role;

typedef enum {
  MOQSUB_EV_OPEN         = 0, /* SUBSCRIBE or PUBLISH sent/received */
  MOQSUB_EV_OK           = 1, /* SUBSCRIBE_OK / PUBLISH_OK (REQUEST_OK) */
  MOQSUB_EV_ERROR        = 2, /* REQUEST_ERROR sent or received */
  MOQSUB_EV_UPDATE       = 3, /* REQUEST_UPDATE: no state change */
  MOQSUB_EV_STOP_SENDING = 4, /* STOP_SENDING sent or received */
  MOQSUB_EV_PUBLISH_DONE = 5, /* PUBLISH_DONE sent or received */
  MOQSUB_EV_FIN_RESP     = 6, /* the responder's direction FIN */
  MOQSUB_EV_FIN_REQ      = 7, /* the requester's direction FIN */
} moqsub_event;

#define MOQSUB_TERM_NONE 0
#define MOQSUB_TERM_STOP_SENDING 1
#define MOQSUB_TERM_PUBLISH_DONE 2
#define MOQSUB_TERM_ERROR 3
#define MOQSUB_TERM_EARLY_FIN 4
#define MOQSUB_TERM_DUP_RESPONSE 5

typedef struct {
  moqsub_state state;
  moqsub_role role;
  int responded;
  int pending_ok;
  int fin_req;
  int fin_resp;
  int term_reason;
  int session_fault;
} moqsub;

void moqsub_init(moqsub* s, moqsub_role role);

int moqsub_step(moqsub* s, moqsub_event ev);

int moqsub_established(const moqsub* s);

int moqsub_terminated(const moqsub* s);

int moqsub_may_forward(const moqsub* s, int forward);

int moqsub_may_send_publish_done(usz open_stream_count);
 
#endif