Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
h2_stream.h File Reference
#include "h2.h"
Include dependency graph for h2_stream.h:

Go to the source code of this file.

Data Structures

struct  h2_stream_monitor
 
struct  h2_stream
 

Macros

#define H2_STREAM_RST(s, def)   (s->rst_error? s->rst_error : (def))
 
#define H2_STRM_MSG(s, msg)   "h2_stream(%ld-%d,%s): "msg, s->session->id, s->id, h2_stream_state_str(s)
 
#define H2_STRM_LOG(aplogno, s, msg)   aplogno H2_STRM_MSG(s, msg)
 

Typedefs

typedef struct h2_stream h2_stream
 
typedef void h2_stream_state_cb (void *ctx, h2_stream *stream)
 
typedef void h2_stream_event_cb (void *ctx, h2_stream *stream, h2_stream_event_t ev)
 
typedef struct h2_stream_monitor h2_stream_monitor
 

Functions

h2_streamh2_stream_create (int id, apr_pool_t *pool, struct h2_session *session, h2_stream_monitor *monitor, int initiated_on)
 
void h2_stream_destroy (h2_stream *stream)
 
apr_status_t h2_stream_prep_processing (h2_stream *stream)
 
void h2_stream_set_monitor (h2_stream *stream, h2_stream_monitor *monitor)
 
void h2_stream_dispatch (h2_stream *stream, h2_stream_event_t ev)
 
void h2_stream_cleanup (h2_stream *stream)
 
apr_status_t h2_stream_in_consumed (h2_stream *stream, apr_off_t amount)
 
void h2_stream_set_request (h2_stream *stream, const h2_request *r)
 
apr_status_t h2_stream_set_request_rec (h2_stream *stream, request_rec *r, int eos)
 
apr_status_t h2_stream_add_header (h2_stream *stream, const char *name, size_t nlen, const char *value, size_t vlen)
 
apr_status_t h2_stream_send_frame (h2_stream *stream, int frame_type, int flags, size_t frame_len)
 
apr_status_t h2_stream_recv_frame (h2_stream *stream, int frame_type, int flags, size_t frame_len)
 
apr_status_t h2_stream_recv_DATA (h2_stream *stream, uint8_t flags, const uint8_t *data, size_t len)
 
apr_status_t h2_stream_flush_input (h2_stream *stream)
 
void h2_stream_rst (h2_stream *stream, int error_code)
 
int h2_stream_was_closed (const h2_stream *stream)
 
apr_status_t h2_stream_out_prepare (h2_stream *stream, apr_off_t *plen, int *peos, h2_headers **presponse)
 
apr_status_t h2_stream_read_to (h2_stream *stream, apr_bucket_brigade *bb, apr_off_t *plen, int *peos)
 
apr_table_th2_stream_get_trailers (h2_stream *stream)
 
apr_status_t h2_stream_submit_pushes (h2_stream *stream, h2_headers *response)
 
const struct h2_priorityh2_stream_get_priority (h2_stream *stream, h2_headers *response)
 
const char * h2_stream_state_str (h2_stream *stream)
 
int h2_stream_is_ready (h2_stream *stream)
 

Macro Definition Documentation

#define H2_STREAM_RST (   s,
  def 
)    (s->rst_error? s->rst_error : (def))
#define H2_STRM_LOG (   aplogno,
  s,
  msg 
)    aplogno H2_STRM_MSG(s, msg)
#define H2_STRM_MSG (   s,
  msg 
)    "h2_stream(%ld-%d,%s): "msg, s->session->id, s->id, h2_stream_state_str(s)

Typedef Documentation

typedef struct h2_stream h2_stream
typedef void h2_stream_event_cb(void *ctx, h2_stream *stream, h2_stream_event_t ev)

Callback structure for events and stream state transisitions

typedef void h2_stream_state_cb(void *ctx, h2_stream *stream)

Function Documentation

apr_status_t h2_stream_add_header ( h2_stream stream,
const char *  name,
size_t  nlen,
const char *  value,
size_t  vlen 
)
void h2_stream_cleanup ( h2_stream stream)

Cleanup references into requst processing.

Parameters
streamthe stream to cleanup
h2_stream* h2_stream_create ( int  id,
apr_pool_t pool,
struct h2_session session,
h2_stream_monitor monitor,
int  initiated_on 
)

Create a stream in H2_SS_IDLE state.

Parameters
idthe stream identifier
poolthe memory pool to use for this stream
sessionthe session this stream belongs to
monitoran optional monitor to be called for events and state transisitions
initiated_onthe id of the stream this one was initiated on (PUSH)
Returns
the newly opened stream
void h2_stream_destroy ( h2_stream stream)

Destroy memory pool if still owned by the stream.

void h2_stream_dispatch ( h2_stream stream,
h2_stream_event_t  ev 
)

Dispatch (handle) an event on the given stream.

Parameters
streamthe streama the event happened on
evthe type of event
apr_status_t h2_stream_flush_input ( h2_stream stream)
const struct h2_priority* h2_stream_get_priority ( h2_stream stream,
h2_headers response 
)

Get priority information set for this stream.

apr_table_t* h2_stream_get_trailers ( h2_stream stream)

Get optional trailers for this stream, may be NULL. Meaningful results can only be expected when the end of the response body has been reached.

Parameters
streamto ask for trailers
Returns
trailers for NULL
apr_status_t h2_stream_in_consumed ( h2_stream stream,
apr_off_t  amount 
)

Notify the stream that amount bytes have been consumed of its input since the last invocation of this method (delta amount).

int h2_stream_is_ready ( h2_stream stream)

Determine if stream is ready for submitting a response or a RST

Parameters
streamthe stream to check
apr_status_t h2_stream_out_prepare ( h2_stream stream,
apr_off_t plen,
int peos,
h2_headers **  presponse 
)

Do a speculative read on the stream output to determine the amount of data that can be read.

Parameters
streamthe stream to speculatively read from
plen(in-/out) number of bytes requested and on return amount of bytes that may be read without blocking
peos(out) != 0 iff end of stream will be reached when reading plen bytes (out value).
presponse(out) the response of one became available
Returns
APR_SUCCESS if out information was computed successfully. APR_EAGAIN if not data is available and end of stream has not been reached yet.
apr_status_t h2_stream_prep_processing ( h2_stream stream)

Prepare the stream so that processing may start.

This is the time to allocated resources not needed before.

Parameters
streamthe stream to prep
apr_status_t h2_stream_read_to ( h2_stream stream,
apr_bucket_brigade bb,
apr_off_t plen,
int peos 
)

Read a maximum number of bytes into the bucket brigade.

Parameters
streamthe stream to read from
bbthe brigade to append output to
plen(in-/out) max. number of bytes to append and on return actual number of bytes appended to brigade
peos(out) != 0 iff end of stream has been reached while reading
Returns
APR_SUCCESS if out information was computed successfully. APR_EAGAIN if not data is available and end of stream has not been reached yet.
apr_status_t h2_stream_recv_DATA ( h2_stream stream,
uint8_t  flags,
const uint8_t *  data,
size_t  len 
)
apr_status_t h2_stream_recv_frame ( h2_stream stream,
int  frame_type,
int  flags,
size_t  frame_len 
)
void h2_stream_rst ( h2_stream stream,
int  error_code 
)

Reset the stream. Stream write/reads will return errors afterwards.

Parameters
streamthe stream to reset
error_codethe HTTP/2 error code
apr_status_t h2_stream_send_frame ( h2_stream stream,
int  frame_type,
int  flags,
size_t  frame_len 
)
void h2_stream_set_monitor ( h2_stream stream,
h2_stream_monitor monitor 
)
void h2_stream_set_request ( h2_stream stream,
const h2_request r 
)

Set complete stream headers from given h2_request.

Parameters
streamstream to write request to
rthe request with all the meta data
eos!= 0 iff stream input is closed
apr_status_t h2_stream_set_request_rec ( h2_stream stream,
request_rec r,
int  eos 
)

Set complete stream header from given request_rec.

Parameters
streamstream to write request to
rthe request with all the meta data
eos!= 0 iff stream input is closed
const char* h2_stream_state_str ( h2_stream stream)

Return a textual representation of the stream state as in RFC 7540 nomenclator, all caps, underscores.

apr_status_t h2_stream_submit_pushes ( h2_stream stream,
h2_headers response 
)

Submit any server push promises on this stream and schedule the tasks connection with these.

Parameters
streamthe stream for which to submit
int h2_stream_was_closed ( const h2_stream stream)

Determine if stream was closed already. This is true for states H2_SS_CLOSED, H2_SS_CLEANUP. But not true for H2_SS_CLOSED_L and H2_SS_CLOSED_R.

Parameters
streamthe stream to check on
Returns
!= 0 iff stream has been closed