protocol.h

Go to the documentation of this file.

#ifndef __PROTOCOL_H__
#define __PROTOCOL_H__


#include "common.h"
#include "errorcodes.h"
#include "protocol_ids.h"
#include "frames.h"
#include "mempool.h"


typedef struct brp_protocol_t * brp_protocol;


typedef int brp_layer_id;


typedef brp_errcode (*brp_cb_generic_t)
(
    brp_protocol protocol
);


typedef brp_errcode (*brp_cb_generic_t)
(
    brp_protocol protocol
);


typedef brp_errcode (*brp_cb_recv_any_frame_t)
(
    brp_protocol protocol,
    brp_time timeout
);


typedef size_t (*brp_cb_fmt_spec_t)
(
    brp_frame frame,
    void * context
);


typedef brp_errcode (*brp_cb_recv_frame_t)
(
    brp_protocol protocol,
    brp_time timeout,
    brp_cb_fmt_spec_t fmt_spec_callback,
    void * context
);


typedef brp_errcode (*brp_cb_get_id_t)
(
    brp_protocol protocol,
    char * * intf_name,
    brp_frame instance_id
);


struct brp_protocol_t
{
    int                 protocol_id;
    brp_layer_id        layer_id;
    brp_protocol        base_protocol;

    brp_cb_generic_t    cb_open;
    brp_cb_generic_t    cb_close;
    brp_cb_generic_t    cb_send_frame;
    brp_cb_recv_any_frame_t cb_recv_any_frame;
    brp_cb_recv_frame_t cb_recv_frame;
    brp_cb_generic_t    cb_flush;
    brp_cb_generic_t    cb_destroy;
    brp_cb_get_id_t     cb_get_id;

    bool                opened;

    struct brp_frame_t  send_frame;

    struct brp_frame_t  recv_frame;

    brp_time            recv_delay;
    
    brp_mempool mempool;
} ;


BRP_LIB brp_errcode brp_send_frame
(
    brp_protocol protocol    
);


BRP_LIB brp_errcode brp_recv_any_frame
(
    brp_protocol protocol,  
    brp_time timeout        
);


BRP_LIB brp_errcode brp_recv_fix_frame
(
    brp_protocol protocol,  
    brp_time timeout,       
    size_t frame_size       
);


BRP_LIB brp_errcode brp_recv_frame
(
    brp_protocol protocol,  
    brp_time timeout,       
    brp_cb_fmt_spec_t fmt_spec_callback,  
    void * context          
);


#define BRP_FMTSPEC_EXPECT_MORE(frame_rdr, requested_byte_cnt) do { \
    if (brp_frame_read_err(frame_rdr)) \
        return -1; \
    else if (brp_frame_rest(frame_rdr) < (requested_byte_cnt)) \
        return (requested_byte_cnt) - brp_frame_rest(frame_rdr); \
} while (0)


#define BRP_FMTSPEC_EXPECT_END(frame_rdr) do { \
    if (! brp_frame_read_eof(frame_rdr)) \
        return -1; \
} while (0)


BRP_LIB void brp_protocol_free(brp_protocol protocol);

BRP_LIB brp_errcode brp_open
(
    brp_protocol protocol     
);


BRP_LIB brp_errcode brp_close
(
    brp_protocol protocol     
);


BRP_LIB brp_errcode brp_flush(brp_protocol);


BRP_LIB brp_errcode brp_get_io_id
(
    brp_protocol protocol,    
    char * * intf_name,       
    brp_frame instance_id     
);


BRP_LIB brp_errcode brp_destroy(brp_protocol);


#endif
 // end of defgroup brp_lib