namespace Coral

Port number. More...

List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Static Methods

Public Members


Detailed Description

Port number.

void  installBreakDetector ()

installBreakDetector

Install break handler.

void  uninstallBreakDetector ()

uninstallBreakDetector

Uninstall break handler.

bool  breakDetected ()

breakDetected

Check, if break has been detected.

void  sendBreak (const bool quiet = false)

sendBreak

Send break to main thread.

Parameters:
quiettrue to print no break message in breakDetected(), false otherwise (default).

Condition (class)

Condition

This class realizes a condition variable.

See also: Synchronizable, Thread

ExtSocketDescriptor (struct)

ExtSocketDescriptor

ExtSocketDescriptorMaster (class)

ExtSocketDescriptorMaster

InternetAddress (class)

InternetAddress

This class manages an internet address.

InternetFlow (class)

InternetFlow

This class inherits InternetAddress and contains an additional flow label for IPv6 support.

MultiTimerThread (class)

MultiTimerThread

This abstract class realizes a timer thread with multiple timers, based on Thread. The user of this class has to implement timerEvent(). Inaccurate system timers are corrected by calling user's timerEvent() implementation multiple times if necessary. This feature can be modified by setTimerCorrection (Default is on at a maximum of 10 calls).

See also: Thread

typedef MultiTimerThread<1> SingleTimerThread

SingleTimerThread

PacketAddress (class)

PacketAddress

This class manages a packet socket address.

PortableAddress (class)

PortableAddress

Binary representation for a socket address for sending the address over a network. The difference between InternetAddress is that PortableAddress does not contain hidden information on virtual function management, which make network transfer of InternetAddress objects problematic.

Randomizer (class)

Randomizer

This class is an randomizer. The randomizer algorithm will calculate random numbers with seed given by system timer (microseconds since January 01, 1970) or given by a number.

SCTPAssociation (class)

SCTPAssociation

This class manages a SCTP assocation. Note: The constructor is protected, a SCTP assocation can be created from an SCTP socket using associate() or accept().

See also: SCTPSocket, SCTPSocket#associate, SCTPSocket#accept

SCTPNotification (struct)

SCTPNotification

SCTP Notification

SCTPNotificationQueue (class)

SCTPNotificationQueue

This class is a queue for SCTP notifications.

SCTPSocket (class)

SCTPSocket

This class manages a SCTP socket (SCTP instance).

SCTPSocketMaster (class)

SCTPSocketMaster

This class manages the interaction between the SCTP Socket class and the userland SCTP implementation. It is implemented as a singleton and automatically instantiated at program startup.

SocketAddress (class)

SocketAddress

This class is an interface for a socket address.

inline ostream&  operator<< (ostream& os, const SocketAddress& sa)

operator<<

Output operator.

StreamSrcDest (class)

StreamSrcDest

This class is contains source and destination of a stream.

ostream&  operator<< (ostream& os, const StreamSrcDest& ssd)

operator<<

<< operator.

Synchronizable (class)

Synchronizable

This class realizes synchronized access to a thread's data by other threads. Synchronization is done by using a global pthread mutex and obtaining access to this mutex by synchronized() for synchronized access and releasing this mutex for unsynchronized access. IMPORTANT: Do *not* use synchronized()/unsynchronized() within async signal handlers. This may cause deadlocks. See PThread's pthread_mutex_lock man-page, section "Async Signal Safety" for more information!

See also: Thread

SocketMessage (class)

SocketMessage

This template class manages manages message structures used by sendmsg() and recvmsg(). The template parameter gives the size of the control data block.

inline char*  CData (const cmsghdr* cmsg)

CData

[static]

Wrapper for CMSG_DATA macro.

inline const cardinal  CLength (const cmsghdr* cmsg)

CLength

[static]

Wrapper for CMSG_LEM macro.

inline cmsghdr*  CFirst (const msghdr* header)

CFirst

[static]

Wrapper for CMSG_FIRSTHDR macro.

inline cmsghdr*  CNext (const msghdr* header, const cmsghdr* cmsg)

CNext

[static]

Wrapper for CMSG_NXTHDR macro.

const cardinal UDPHeaderSize

UDPHeaderSize

const cardinal IPv4HeaderSize

IPv4HeaderSize

const cardinal IPv6HeaderSize

IPv6HeaderSize

Socket (class)

Socket

This class manages a socket. IPv6 support is automatically available, when supported by the system.

Thread (class)

Thread

This abstract class realizes threads based on Linux's pthreads. The user of this class has to implement run(). Synchronization is implemented by inheriting Synchronizable. IMPORTANT: Do *not* use Thread methods within async signal handlers. This may cause deadlocks. See PThread's pthread_mutex_lock man-page, section "Async Signal Safety" for more information!

See also: Synchronizable

TimedThread (class)

TimedThread

This abstract class realizes a timed thread based on MultiTimerThread. The user of this class has to implement timerEvent(). Inaccurate system timers are corrected by calling user's timerEvent() implementation multiple times if necessary. This feature can be modified by setTimerCorrection (Default is on at a maximum of 10 calls).

See also: Thread

inline void  debug (const char* string)

debug

Debug output.

Parameters:
stringDebug string to be written to cerr.

inline card64  getMicroTime ()

getMicroTime

Get microseconds since January 01, 1970.

Returns: Microseconds since January 01, 1970.

inline card16  translate16 (const card16 x)

translate16

Translate 16-bit value to network byte order.

Parameters:
xValue to be translated.

Returns: Translated value.

inline card32  translate32 (const card32 x)

translate32

Translate 32-bit value to network byte order.

Parameters:
xValue to be translated.

Returns: Translated value.

inline card64  translate64 (const card64 x)

translate64

Translate 64-bit value to network byte order.

Parameters:
xValue to be translated.

Returns: Translated value.

inline card64  translateToBinary (const double x)

translateToBinary

Translate double to 64-bit binary.

Parameters:
xValue to be translated.

Returns: Translated value.

inline double  translateToDouble (const card64 x)

translateToDouble

Translate 64-bit binary to double.

Parameters:
xValue to be translated.

Returns: Translated value.

cardinal  calculatePacketsPerSecond (const cardinal payloadBytesPerSecond, const cardinal framesPerSecond, const cardinal maxPacketSize, const cardinal headerLength)

calculatePacketsPerSecond

Calculate packets per second.

Asumption: Every frame has it's own packets.

Parameters:
payloadBytesPerSecondByte rate of payload data.
framesPerSecondFrame rate.
maxPacketSizeMaximum size of a packet.
headerLengthLength of header for each frame.

Returns: Total bytes per second.

cardinal  calculateBytesPerSecond (const cardinal payloadBytesPerSecond, const cardinal framesPerSecond, const cardinal maxPacketSize, const cardinal headerLength)

calculateBytesPerSecond

Calculate frames per second.

Asumption: Every frame has it's own packets.

Parameters:
payloadBytesPerSecondByte rate of payload data.
framesPerSecondFrame rate.
maxPacketSizeMaximum size of a packet.
headerLengthLength of header for each frame.

Returns: Total frames per second.

bool  scanURL (const String& location, String& protocol, String& host, String& path)

scanURL

Scan protocol, host and path from an URL string. The protocol my be missing, if the String "protocol" is initialized with a default.

Parameters:
locationString with URL.
protocolPlace to store the protocol name.
hostPlace to store the host name.
pathPlace to store the path.

Returns: true on success; false otherwise.

bool  getUserName (char* str, const size_t size, const bool realName = false, const uid_t uid = getuid())

getUserName

Get user name for given user ID.

Parameters:
strBuffer to store name to.
sizeSize of buffer.
realNametrue to get real name (e.g. John Miller); false to get user name (e.g. jmiller).
uidUser ID.

Returns: true for success; false otherwise.

template<class T> void  quickSort (T* array, const integer start, const integer end)

quickSort

Sort array using QuickSort algorithm.

Parameters:
arrayArray to be sorted.
startStart offset in array.
endEnd offset in array.

template<class T> void  quickSortPtr (T* array, const integer start, const integer end, bool (*lt)(T,T), bool (*gt)(T,T))

quickSortPtr

Sort pointer array using QuickSort algorithm.

Parameters:
arrayArray to be sorted.
startStart offset in array.
endEnd offset in array.
ltLess than comparision routine.
gtGreater than comparision routine.

template<class T> void  quickSortGroupPtr (T* array, const integer start, const integer end, bool (*lt)(T,T), bool (*gt)(T,T), bool (*geq)(T,T))

quickSortGroupPtr

Sort pointer array using QuickSort algorithm.

Parameters:
arrayArray to be sorted.
startStart offset in array.
endEnd offset in array.
ltLess than comparision routine for sorting.
gtGreater than comparision routine for sorting.
geqEqual routine for separation of groups.

template<class T> cardinal  removeDuplicates (T* array, const cardinal length)

removeDuplicates

Remove duplicates from *sorted* array.

Parameters:
arrayArray to be sorted.
lengthLength of array.

void  printTimeStamp (ostream& os = cout)

printTimeStamp

Print time stamp (date and time) to given output stream.

Parameters:
osOutput stream.

TrafficClassValues (class)

TrafficClassValues

This class contains a set of values for the traffic class/TOS byte of IP packets. This class contains only static methods and attributes.

UnixAddress (class)

UnixAddress

This class manages an unix socket address.


Generated by: dreibh@kappes on Fri Nov 30 14:03:21 2001, using kdoc 2.0a53.