Table of contents

Classes

• Appl topmost class
• Event event with the type and timestamp attached
• JobElem Each user have a queue of jobs
• PacketHeader
• RemoteUser one record per each remote user; Note that the broadcast stream from channel and broadcast channels output from this stream is the user too
• Sockaddr hides all operations with struct sockaddr_in
• Timeval hides all operations with struct timeval

Functions, Macros

• accept_stream_impl no parameters passed: push server should be configured to what port to listen from environment
• acceptNewConnection after readControlData receive command accept_stream, it open the server socket and wait for incoming connection
• add_broadcast_channel Only for the broadcast fake user
• add_broadcast_destination_impl
• Appl
• bindAcceptWaitSocket return true if no errors
• calc_next_packet_time
• cleanup_jobs cleanup everything for this user
• cleanup
• closeOldBroadcasting as is
• construct
• Event
• execute_load_event process next event, even it is too early to do it if this function is called, then we have nothing to do else
• execute_send_event forced to execute the next send event
• get_description
• JobElem
• load_packet
• loadIncomingData nonblock read of all pending TCP stream data at the socket
• log log message if its level is equal or less than verbose level
• operator < :
  • in Event
  • in Sockaddr
• operator ==
• operator = :
  • in Event
  • in JobElem
  • in Sockaddr
• operator const struct timeval &
• operator const struct timeval *
• parse_command parse, call callbacks, but do not delete buf
• play_impl callback to parse interface commands are postfixed with _impl
• readControlData wait_for_network_event calls this to read data
• RemoteUser
• restart_count
• run
• send_packet
• setfilename_impl
• shutdown
• Sockaddr
• stop_impl
• stoprecording_impl
• Timeval
• trim_string util
• valid
• wait_for_network_event check if we have nothing to do and wait for incoming packets or check for input when nextTimeToCheckInput come
• ~JobElem
• ~RemoteUser

Variables

• acceptWaitPortnum remember the port number of acceptWaitSocket for future reconnections
• acceptWaitSocket socket to accept incoming broadcast TCP stream
• addr
• broadcast_user this is special user, which represents the outgoing broadcasts connections
• commandsMap fill this map in constructor
• controlSocket Control socket
• dataloaded data loaded since last local StartTime setup
• dataOffset offset may be not sizeof( header ) + text size, may be greater
• datarate bytes per second
• datasent data sent since last local StartTime setup
• dataSize should not be zero
• dataToSend allocate a vector of buffers to send to user
• env_postfix_cp
• env_postfix_wp
• env_prefix
• eQueueT
• eventQueue
• fileLength
• filename :
  • in JobElem
  • in PacketHeader keep only file name, not path
• fp
• fullpath
• incomingDataBuffer buffer to preload incoming data from the acquisition server
• incomingDataBufferDataLength
• incomingDataBufferOffset
• incomingDataSockaddr this single sockaddr uniquely identify the incoming data stream
• incomingDataSocket use this socket to read incoming TCP data stream
• inusedBuffers
• jobs queue of jobs to do
• loadDataChunk what chunk of data to read from disk per call
• load
• localStartTime start time in local time
• log_output stream to output all logging
• maxPacketLength
• movieStartTime start time in movie time
• nextTimeToCheckInput store the next time when input sockets must be checked
• outputSocket socket to write data to this user, ( write-only socket)
• outputSockets if user is actually the broadcast destination - it's outputSocket remains -1, but the vector of outputSockets is used
• outputSocketsT
• packetSize size of header + size of text + size of data
• playFrom
• priority
• queueHighWaterMark
• queueLowWaterMark
• send
• sequence :
  • in PacketHeader sequence number may not be user for anything exept detecting lost packets
  • in RemoteUser sequence number is attached to user and is not related to jobs
• socketAddr unique user id = socket
• sock
• start
• startOffset start file pos
• stop
• textOffset offset may be not sizeof( header ), may be greater
• textSize may be zero
• type :
  • in Event
  • in PacketHeader
• typeT
• users list of users, organized as map, key = sockaddr
• userSocketAddr when type is broadcast - undefined
• value
• verbose_level debug level
• videoFileHandle file handle to store video stream
• videoFileName current fname to store video stream
• when

Enums, Unions, Structs

• &val
• OutputDestination all data associated with particular broadcast destination