receiver Struct Reference

Describes a possible data source for audio streams. More...

#include <recv.h>

Data Fields
int(*	open )(struct receiver_node *rn)
	Open one instance of the receiver. More...
void(*	close )(struct receiver_node *rn)
	Close this instance of the receiver. More...
void(*	pre_monitor )(struct sched *s, void *context)
	Ask the scheduler to monitor receive fds. More...
int(*	post_monitor )(struct sched *s, void *context)
	Receive data and make it available to consumers. More...
btr_command_handler	execute
	Answer a buffer tree query. More...

Detailed Description

Describes a possible data source for audio streams.

A paraslash receiver is a modular piece of software which is capable of receiving an audio data stream from a data source. Received audio data is fed to consumers through the buffer tree mechanism.

This structure contains the methods which have to be implemented by each receiver.

See also

http_recv.c, udp_recv.c, dccp_recv.c, afh_recv.c, struct receiver_node, struct filter, struct writer, struct sched.

Field Documentation

open

int(* open) (struct receiver_node *rn)

Open one instance of the receiver.

This should allocate the output buffer of the given receiver node and prepare it for retrieving the audio stream according to the configuration stored in rn->lpr.

close

void(* close) (struct receiver_node *rn)

Close this instance of the receiver.

It should free all resources associated with given receiver node that were allocated during the corresponding open call.

See also

receiver_node.

pre_monitor

void(* pre_monitor) (struct sched *s, void *context)

Ask the scheduler to monitor receive fds.

post_monitor

int(* post_monitor) (struct sched *s, void *context)

Receive data and make it available to consumers.

execute

btr_command_handler execute

Answer a buffer tree query.

This optional function pointer allows for inter node communication of the buffer tree nodes. See btr_command_handler for details.

---

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

• recv.h