Function

nw_framer_parse_output

Examines the content of output data while inside your output handler.

Declaration

bool nw_framer_parse_output(nw_framer_t framer, size_t minimum_incomplete_length, size_t maximum_length, uint8_t *temp_buffer, nw_framer_parse_completion_t parse);

Parameters

minimum_incomplete_length

The minimum number of bytes that should be delivered to the parse completion.

maximum_length

The maximum number of bytes that should be delivered to the parse completion.

temp_buffer

An optional buffer into which the parser will copy bytes. Use this if you need to make guarantees about byte alignment.

parse

A completion handler that will be called inline to examine a region of bytes.

Return Value

Returns true if the requested length was available to parse, or false if the conditions could not be met.

See Also

Handling Output Data

nw_framer_set_output_handler

Sets a block to handle new outbound messages.

nw_framer_output_handler_t

A handler that notifies your protocol about a new outbound message.

nw_framer_parse_completion_t

A handler that examines a range of data being sent or received.

nw_framer_write_output

Sends arbitrary output data in a buffer from your protocol to the next protocol.

nw_framer_write_output_data

Sends arbitrary output data from your protocol to the next protocol.

nw_framer_write_output_no_copy

Sends a specific number of bytes from a message while inside your output handler.

nw_framer_pass_through_output

Indicates that your protocol no longer needs to handle output data.