libsparklepaw/transport_8h_source.html

#ifndef SPRKL_TRANSPORT_H

#define SPRKL_TRANSPORT_H


#include "request.h"


#include <stdio.h>


struct sprkl_transport {

        void* opaque;

        int (*sendrequest)(struct sprkl_transport*, struct sprkl_request*);

        int (*recvrequest)(struct sprkl_transport*, struct sprkl_request*);

        int (*sendresponse)(struct sprkl_transport*, struct sprkl_response*);

        int (*recvresponse)(struct sprkl_transport*, struct sprkl_response*);

        char* (*strerror)(struct sprkl_transport*, int);

};


int sprkl_transport_sendrequest(

        struct sprkl_transport* t, struct sprkl_request* request);


int sprkl_transport_recvrequest(

        struct sprkl_transport* t, struct sprkl_request* request);


int sprkl_transport_sendresponse(

        struct sprkl_transport* t, struct sprkl_response* response);


int sprkl_transport_recvresponse(

        struct sprkl_transport* t, struct sprkl_response* response);


char* sprkl_transport_strerror(struct sprkl_transport* t, int error);


struct sprkl_transport sprkl_transport_make_stream(FILE* stream);


int sprkl_transport_make_default(struct sprkl_transport* transport);


void sprkl_transport_fini_default(struct sprkl_transport* transport);


#endif

request.h
Requests and responses.

sprkl_request
Request tagged union.
Definition request.h:74

sprkl_response
Response tagged union (varies on the associated request verb and status).
Definition request.h:84

sprkl_transport
Generic transport vtable.
Definition transport.h:15

sprkl_transport::sendrequest
int(* sendrequest)(struct sprkl_transport *, struct sprkl_request *)
Sends a request through the transport.
Definition transport.h:21

sprkl_transport::recvresponse
int(* recvresponse)(struct sprkl_transport *, struct sprkl_response *)
Waits for and receives a response through the transport.
Definition transport.h:37

sprkl_transport::recvrequest
int(* recvrequest)(struct sprkl_transport *, struct sprkl_request *)
Waits for and receives a request through the transport.
Definition transport.h:26

sprkl_transport::sendresponse
int(* sendresponse)(struct sprkl_transport *, struct sprkl_response *)
Sends a response through the transport.
Definition transport.h:31

sprkl_transport::opaque
void * opaque
Instance-specific data.
Definition transport.h:16

sprkl_transport_fini_default
void sprkl_transport_fini_default(struct sprkl_transport *transport)
Finalises the default transport.
Definition transport.c:101

sprkl_transport_sendrequest
int sprkl_transport_sendrequest(struct sprkl_transport *t, struct sprkl_request *request)
Sends a request via the given transport.
Definition transport.c:11

sprkl_transport_recvresponse
int sprkl_transport_recvresponse(struct sprkl_transport *t, struct sprkl_response *response)
Receives a response via the given transport.
Definition transport.c:26

sprkl_transport_make_default
int sprkl_transport_make_default(struct sprkl_transport *transport)
Creates the platform's default transport, usually configured by environment variable(s).
Definition transport.c:82

sprkl_transport_sendresponse
int sprkl_transport_sendresponse(struct sprkl_transport *t, struct sprkl_response *response)
Sends a response via the given transport.
Definition transport.c:21

sprkl_transport_strerror
char * sprkl_transport_strerror(struct sprkl_transport *t, int error)
Converts a transport-defined error number to a string description.
Definition transport.c:31

sprkl_transport_recvrequest
int sprkl_transport_recvrequest(struct sprkl_transport *t, struct sprkl_request *request)
Receives a request via the given transport.
Definition transport.c:16