Icecast client context. More...

#include <icecast_client.h>

Data Fields
IcecastClientSettings	settings
	User settings. More...

OsMutex	mutex
	Mutex protecting critical sections. More...

OsEvent	writeEvent
	This event tells whether the buffer is writable. More...

OsEvent	readEvent
	This event tells whether the buffer is readable. More...

OsTaskParameters	taskParams
	Task parameters. More...

OsTaskId	taskId
	Task identifier. More...

Socket *	socket
	Underlying socket. More...

size_t	blockSize
	Number of data bytes between subsequent metadata blocks. More...

uint8_t *	streamBuffer
	Streaming buffer. More...

size_t	bufferSize
	Streaming buffer size. More...

size_t	bufferLength
	Streaming buffer length. More...

size_t	writeIndex
	Current write index within the buffer. More...

size_t	readIndex
	Current read index within the buffer. More...

size_t	totalLength
	Total number of bytes that have been received. More...

char_t	buffer [ICECAST_CLIENT_METADATA_MAX_SIZE]
	Memory buffer for input/output operations. More...

char_t	metadata [ICECAST_CLIENT_METADATA_MAX_SIZE]
	Metadata information. More...

size_t	metadataLength
	Length of the metadata. More...

Detailed Description

Icecast client context.

Definition at line 117 of file icecast_client.h.

Field Documentation

◆ blockSize

size_t blockSize

Number of data bytes between subsequent metadata blocks.

Definition at line 126 of file icecast_client.h.

◆ buffer

char_t buffer[ICECAST_CLIENT_METADATA_MAX_SIZE]

Memory buffer for input/output operations.

Definition at line 133 of file icecast_client.h.

◆ bufferLength

size_t bufferLength

Streaming buffer length.

Definition at line 129 of file icecast_client.h.

◆ bufferSize

size_t bufferSize

Streaming buffer size.

Definition at line 128 of file icecast_client.h.

◆ metadata

char_t metadata[ICECAST_CLIENT_METADATA_MAX_SIZE]

Metadata information.

Definition at line 134 of file icecast_client.h.

◆ metadataLength

size_t metadataLength

Length of the metadata.

Definition at line 135 of file icecast_client.h.

◆ mutex

OsMutex mutex

Mutex protecting critical sections.

Definition at line 120 of file icecast_client.h.

◆ readEvent

OsEvent readEvent

This event tells whether the buffer is readable.

Definition at line 122 of file icecast_client.h.

◆ readIndex

size_t readIndex

Current read index within the buffer.

Definition at line 131 of file icecast_client.h.

◆ settings

IcecastClientSettings settings

User settings.

Definition at line 119 of file icecast_client.h.

◆ socket

Socket* socket

Underlying socket.

Definition at line 125 of file icecast_client.h.

◆ streamBuffer

uint8_t* streamBuffer

Streaming buffer.

Definition at line 127 of file icecast_client.h.

◆ taskId

OsTaskId taskId

Task identifier.

Definition at line 124 of file icecast_client.h.

◆ taskParams

OsTaskParameters taskParams

Task parameters.

Definition at line 123 of file icecast_client.h.

◆ totalLength

size_t totalLength

Total number of bytes that have been received.

Definition at line 132 of file icecast_client.h.

◆ writeEvent

OsEvent writeEvent

This event tells whether the buffer is writable.

Definition at line 121 of file icecast_client.h.

◆ writeIndex

size_t writeIndex

Current write index within the buffer.

Definition at line 130 of file icecast_client.h.

The documentation for this struct was generated from the following file:

cyclone_tcp/icecast/icecast_client.h

Data Fields