Psyllid  v1.12.4
Project 8 Data Acquisisition Software
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
packet_receiver_socket Class Reference

A producer to receive UDP packets via the standard socket interface and write them as raw blocks of memory. More...

#include <packet_receiver_socket.hh>

Inheritance diagram for packet_receiver_socket:
Inheritance graph

Public Member Functions

 packet_receiver_socket ()
 
virtual ~packet_receiver_socket ()
 
 mv_accessible (uint64_t, length)
 
 mv_accessible (uint32_t, max_packet_size)
 
 mv_accessible (uint32_t, port)
 
 mv_referrable (std::string, ip)
 
 mv_accessible (unsigned, timeout_sec)
 
virtual void initialize ()
 Timeout in seconds for waiting on socket recv function. More...
 
virtual void execute (midge::diptera *a_midge=nullptr)
 
virtual void finalize ()
 

Protected Attributes

int f_last_errno
 

Private Member Functions

void cleanup_socket ()
 

Private Attributes

int f_socket
 
sockaddr_in * f_address
 

Detailed Description

A producer to receive UDP packets via the standard socket interface and write them as raw blocks of memory.

Author
N. S. Oblath

Parameter setting is not thread-safe. Executing is thread-safe.

Node type: "packet-receiver-socket"

Available configuration values:

Output Streams:

Definition at line 49 of file packet_receiver_socket.hh.

Constructor & Destructor Documentation

◆ packet_receiver_socket()

Definition at line 34 of file packet_receiver_socket.cc.

◆ ~packet_receiver_socket()

~packet_receiver_socket ( )
virtual

Definition at line 46 of file packet_receiver_socket.cc.

Member Function Documentation

◆ cleanup_socket()

void cleanup_socket ( )
private

Definition at line 207 of file packet_receiver_socket.cc.

◆ execute()

void execute ( midge::diptera *  a_midge = nullptr)
virtual

Definition at line 113 of file packet_receiver_socket.cc.

◆ finalize()

void finalize ( )
virtual

Definition at line 198 of file packet_receiver_socket.cc.

◆ initialize()

void initialize ( )
virtual

Timeout in seconds for waiting on socket recv function.

Definition at line 51 of file packet_receiver_socket.cc.

◆ mv_accessible() [1/4]

mv_accessible ( uint64_t  ,
length   
)

◆ mv_accessible() [2/4]

mv_accessible ( uint32_t  ,
max_packet_size   
)

◆ mv_accessible() [3/4]

mv_accessible ( uint32_t  ,
port   
)

◆ mv_accessible() [4/4]

mv_accessible ( unsigned  ,
timeout_sec   
)

◆ mv_referrable()

mv_referrable ( std::string  ,
ip   
)

Member Data Documentation

◆ f_address

sockaddr_in* f_address
private

Definition at line 71 of file packet_receiver_socket.hh.

◆ f_last_errno

int f_last_errno
protected

Definition at line 74 of file packet_receiver_socket.hh.

◆ f_socket

int f_socket
private

Definition at line 70 of file packet_receiver_socket.hh.


The documentation for this class was generated from the following files: