Functions
int	ltrx_input_stream_case_compare (struct input_stream s1, struct input_stream s2)
	Compare independent of case.

void	ltrx_input_stream_close (struct input_stream *inStream)
	Closes the input stream.

int	ltrx_input_stream_compare (struct input_stream s1, struct input_stream s2)
	Compare with case sensitivity.

bool	ltrx_input_stream_init_from_binary (struct input_stream_from_binary inStream, const void data, size_t length)
	Construct input stream from binary.

bool	ltrx_input_stream_init_from_const_char (struct input_stream_from_const_char inStream, const char data)
	Construct input stream from const char.

bool	ltrx_input_stream_init_from_routine (struct input_stream_from_routine concreteInStream, const char thread_name, uint32_t stack_size, void(routine)(struct output_stream os, void opaque), void opaque)
	Construct input stream from routine.

int	ltrx_input_stream_peek (struct input_stream *inStream)
	Non-blocking peek.

int	ltrx_input_stream_peek_with_block_time (struct input_stream *inStream, uint32_t blockTimeMsec)
	Blocking peek.

int	ltrx_input_stream_read (struct input_stream *inStream)
	Blocking read from an input stream.

bool	ltrx_output_stream_close (struct output_stream *outStream)
	Closes the output stream.

bool	ltrx_output_stream_flush_data (struct output_stream *outStream)
	Forces any buffered data to be actually output.

bool	ltrx_output_stream_from_input_stream (struct output_stream outStream, struct input_stream inStream)
	Writes output stream till disconnected, and closes input.

bool	ltrx_output_stream_write_binary (struct output_stream outStream, const void data, size_t length)
	Writes binary data.

bool	ltrx_output_stream_write_hexadecimal (struct output_stream *outStream, uint32_t value)
	Writes unsigned value as ASCII hexadecimal.

bool	ltrx_output_stream_write_line (struct output_stream outStream, const char data)
	Writes data ending with newline.

bool	ltrx_output_stream_write_unsigned (struct output_stream *outStream, uint32_t value)
	Writes unsigned value as ASCII decimal.

bool	ltrx_output_stream_write_without_ending_line (struct output_stream outStream, const char data)
	Writes data without any newline.

Detailed Description

Streams provide a method to input or output single characters at a time independent of the device or construct they are connected to.

Function Documentation

◆ ltrx_input_stream_case_compare()

int ltrx_input_stream_case_compare	(	struct input_stream *	s1,
		struct input_stream *	s2 )

Compare independent of case.

It peeks first, so in case of mismatch, both streams will not yet have read the mismatched character.

Return values

-1	Mismatch less.
0	Identical.
1	Mismatch greater.

Parameters

[in]	s1	The first input stream to be compared.
[in]	s2	The second input stream to be compared.

◆ ltrx_input_stream_close()

void ltrx_input_stream_close ( struct input_stream * inStream )

Closes the input stream.

Parameters

inStream [in,out] The abstract input stream.

◆ ltrx_input_stream_compare()

int ltrx_input_stream_compare	(	struct input_stream *	s1,
		struct input_stream *	s2 )

Compare with case sensitivity.

It peeks first, so in case of mismatch, both streams will not yet have read the mismatched character.

Return values

-1	Mismatch less.
0	Identical.
1	Mismatch greater.

Parameters

[in]	s1	The first input stream to be compared.
[in]	s2	The second input stream to be compared.

◆ ltrx_input_stream_init_from_binary()

bool ltrx_input_stream_init_from_binary	(	struct input_stream_from_binary *	inStream,
		const void *	data,
		size_t	length )

Construct input stream from binary.

Return values

true	Success.
false	Failed.

Parameters

[out]	inStream	The concrete input stream from binary struct.
[in]	data	The const data that will feed the stream.
[in]	length	The number of bytes of data that will feed the stream.

◆ ltrx_input_stream_init_from_const_char()

bool ltrx_input_stream_init_from_const_char	(	struct input_stream_from_const_char *	inStream,
		const char *	data )

Construct input stream from const char.

Return values

true	Success.
false	Failed.

Parameters

[out]	inStream	The concrete input stream from const char struct.
[in]	data	The zero-terminated const data that will feed the stream.

◆ ltrx_input_stream_init_from_routine()

bool ltrx_input_stream_init_from_routine	(	struct input_stream_from_routine *	concreteInStream,
		const char *	thread_name,
		uint32_t	stack_size,
		void(*	routine )(struct output_stream os, void opaque),
		void *	opaque )

Construct input stream from routine.

Return values

true	Success.
false	Failed.

Parameters

[out]	concreteInStream	The concrete input stream from routine struct.
[in]	thread_name	Name of the thread.
[in]	stack_size	Thread stack size in bytes.
[in]	routine	The routine to run in the thread.
[in]	opaque	Any data needed by the routine.

◆ ltrx_input_stream_peek()

int ltrx_input_stream_peek ( struct input_stream * inStream )

Non-blocking peek.

Note that any character you see will remain in the stream until you later read it.

Returns: Next character on inStream.

Return values

-1	Waiting.
-2	Disconnected.

Parameters

[in] inStream The abstract input stream.

◆ ltrx_input_stream_peek_with_block_time()

int ltrx_input_stream_peek_with_block_time	(	struct input_stream *	inStream,
		uint32_t	blockTimeMsec )

Blocking peek.

Note that any character you see will remain in the stream until you later read it.

Returns: Next character on inStream.

Return values

-1	Waiting.
-2	Disconnected.

Parameters

[in]	inStream	The abstract input stream.
[in]	blockTimeMsec	How long to wait if no character is available. To wait indefinitely, use TIME_WAIT_FOREVER.

◆ ltrx_input_stream_read()

int ltrx_input_stream_read ( struct input_stream * inStream )

Blocking read from an input stream.

Returns: Next character on inStream.

Return values

<0	Disconnected.

Parameters

inStream [in,out] The abstract input stream.

◆ ltrx_output_stream_close()

bool ltrx_output_stream_close ( struct output_stream * outStream )

Closes the output stream.

Return values

true	Success.
false	Failed.

Parameters

outStream [in,out] The abstract output stream.

◆ ltrx_output_stream_flush_data()

bool ltrx_output_stream_flush_data ( struct output_stream * outStream )

Forces any buffered data to be actually output.

Return values

true	Success.
false	Failed.

Parameters

outStream [in,out] The abstract output stream.

◆ ltrx_output_stream_from_input_stream()

bool ltrx_output_stream_from_input_stream	(	struct output_stream *	outStream,
		struct input_stream *	inStream )

Writes output stream till disconnected, and closes input.

Return values

true	Success.
false	Failed.

Parameters

outStream	[in,out] The abstract output stream.
inStream	[in,out] The abstract input stream.

◆ ltrx_output_stream_write_binary()

bool ltrx_output_stream_write_binary	(	struct output_stream *	outStream,
		const void *	data,
		size_t	length )

Writes binary data.

Return values

true	Success.
false	Failed.

Parameters

	outStream	[in,out] The abstract output stream.
[in]	data	The binary data to write.
[in]	length	The length in bytes of the data to write.

◆ ltrx_output_stream_write_hexadecimal()

bool ltrx_output_stream_write_hexadecimal	(	struct output_stream *	outStream,
		uint32_t	value )

Writes unsigned value as ASCII hexadecimal.

Return values

true	Success.
false	Failed.

Parameters

	outStream	[in,out] The abstract output stream.
[in]	value	The unsigned value to write.

◆ ltrx_output_stream_write_line()

bool ltrx_output_stream_write_line	(	struct output_stream *	outStream,
		const char *	data )

Writes data ending with newline.

An interface-dependent newline is sent after first sending data.

Return values

true	Success.
false	Failed.

Parameters

	outStream	[in,out] The abstract output stream.
[in]	data	The zero-terminated data to write.

◆ ltrx_output_stream_write_unsigned()

bool ltrx_output_stream_write_unsigned	(	struct output_stream *	outStream,
		uint32_t	value )

Writes unsigned value as ASCII decimal.

Return values

true	Success.
false	Failed.

Parameters

	outStream	[in,out] The abstract output stream.
[in]	value	The unsigned value to write.

◆ ltrx_output_stream_write_without_ending_line()

bool ltrx_output_stream_write_without_ending_line	(	struct output_stream *	outStream,
		const char *	data )

Writes data without any newline.

Return values

true	Success.
false	Failed.

Parameters

	outStream	[in,out] The abstract output stream.
[in]	data	The zero-terminated data to write.

Functions

Detailed Description

Function Documentation

◆ ltrx_input_stream_case_compare()

◆ ltrx_input_stream_close()

◆ ltrx_input_stream_compare()

◆ ltrx_input_stream_init_from_binary()

◆ ltrx_input_stream_init_from_const_char()

◆ ltrx_input_stream_init_from_routine()

◆ ltrx_input_stream_peek()

◆ ltrx_input_stream_peek_with_block_time()

◆ ltrx_input_stream_read()

◆ ltrx_output_stream_close()

◆ ltrx_output_stream_flush_data()

◆ ltrx_output_stream_from_input_stream()

◆ ltrx_output_stream_write_binary()

◆ ltrx_output_stream_write_hexadecimal()

◆ ltrx_output_stream_write_line()

◆ ltrx_output_stream_write_unsigned()

◆ ltrx_output_stream_write_without_ending_line()