Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

IcecastClientContext Struct Reference

IcecastClientContext Struct Reference

Icecast client context. More...

#include <icecast_client.h>

Data Fields

IcecastClientSettings settings
 User settings.
OsMutex mutex
 Mutex protecting critical sections.
OsEvent writeEvent
 This event tells whether the buffer is writable.
OsEvent readEvent
 This event tells whether the buffer is readable.
Socket * socket
 Underlying socket.
size_t blockSize
 Number of data bytes between subsequent metadata blocks.
uint8_t * streamBuffer
 Streaming buffer.
size_t bufferSize
 Streaming buffer size.
size_t bufferLength
 Streaming buffer length.
size_t writeIndex
 Current write index within the buffer.
size_t readIndex
 Current read index within the buffer.
size_t totalLength
 Total number of bytes that have been received.
char_t buffer [ICECAST_CLIENT_METADATA_MAX_SIZE]
 Memory buffer for input/output operations.
char_t metadata [ICECAST_CLIENT_METADATA_MAX_SIZE]
 Metadata information.
size_t metadataLength
 Length of the metadata.

Detailed Description

Icecast client context.

Definition at line 109 of file icecast_client.h.


Field Documentation

size_t blockSize

Number of data bytes between subsequent metadata blocks.

Definition at line 116 of file icecast_client.h.

char_t buffer[ICECAST_CLIENT_METADATA_MAX_SIZE]

Memory buffer for input/output operations.

Definition at line 123 of file icecast_client.h.

size_t bufferLength

Streaming buffer length.

Definition at line 119 of file icecast_client.h.

size_t bufferSize

Streaming buffer size.

Definition at line 118 of file icecast_client.h.

char_t metadata[ICECAST_CLIENT_METADATA_MAX_SIZE]

Metadata information.

Definition at line 124 of file icecast_client.h.

Length of the metadata.

Definition at line 125 of file icecast_client.h.

Mutex protecting critical sections.

Definition at line 112 of file icecast_client.h.

This event tells whether the buffer is readable.

Definition at line 114 of file icecast_client.h.

size_t readIndex

Current read index within the buffer.

Definition at line 121 of file icecast_client.h.

User settings.

Definition at line 111 of file icecast_client.h.

Socket* socket

Underlying socket.

Definition at line 115 of file icecast_client.h.

uint8_t* streamBuffer

Streaming buffer.

Definition at line 117 of file icecast_client.h.

size_t totalLength

Total number of bytes that have been received.

Definition at line 122 of file icecast_client.h.

This event tells whether the buffer is writable.

Definition at line 113 of file icecast_client.h.

size_t writeIndex

Current write index within the buffer.

Definition at line 120 of file icecast_client.h.