stk_udp_listener_api.h File Reference

#include "stk_data_flow.h"

Include dependency graph for stk_udp_listener_api.h:

Go to the source code of this file.

Macros
#define	stk_udp_create_subscriber   stk_udp_listener_create_data_flow

Functions
stk_data_flow_t *	stk_udp_listener_create_data_flow (stk_env_t *env, char *name, stk_uint64 id, stk_options_t *options)
int	stk_udp_listener_fd (stk_data_flow_t *svr_df)
stk_sequence_t *	stk_udp_listener_data_flow_rcv (stk_data_flow_t *df, stk_sequence_t *data_sequence, stk_uint64 flags)
stk_ret	stk_udp_listener_data_flow_id_ip (stk_data_flow_t *df, struct sockaddr *data_flow_id, socklen_t addrlen)
stk_ret	stk_udp_listener_data_flow_clientip (stk_data_flow_t *df, struct sockaddr *data_flow_id, socklen_t addrlen)

Detailed Description

The UDP listener module provides UDP listening sockets to applications. This module implements the data flow interface specified by the Sequence Toolkit. Applications should use the create API defined here, but use the standard destroy/send/receive APIs in stk_data_flow_api.h Applications may only receive on data flows.

Macro Definition Documentation

#define stk_udp_create_subscriber   stk_udp_listener_create_data_flow

Alias for Subscribers

Function Documentation

stk_data_flow_t* stk_udp_listener_create_data_flow	(	stk_env_t *	env,
		char *	name,
		stk_uint64	id,
		stk_options_t *	options
	)

Create a UDP listening data flow

See Also

stk_options.txt for accepted options

stk_data_flow.h

Returns

A handle to a Sequence Data Flow

stk_ret stk_udp_listener_data_flow_clientip	(	stk_data_flow_t *	df,
		struct sockaddr *	data_flow_id,
		socklen_t	addrlen
	)

Get the client IP for this data flow.

Returns

Whether the IP address was filled out

stk_ret stk_udp_listener_data_flow_id_ip	(	stk_data_flow_t *	df,
		struct sockaddr *	data_flow_id,
		socklen_t	addrlen
	)

Get the IP acting as the ID for this data flow.

Returns

Whether the IP address was filled out

stk_sequence_t* stk_udp_listener_data_flow_rcv	(	stk_data_flow_t *	df,
		stk_sequence_t *	data_sequence,
		stk_uint64	flags
	)

Receive data from a UDP data flow

Returns

The sequence containing received data (if any)

int stk_udp_listener_fd

(

stk_data_flow_t *

svr_df

)

Get the File Descriptor for a data flow. Applications may use this to register with an event processing loop which calls select()/poll() etc.

Returns

The File Descriptor.