eq::net::Global Class Reference

Global parameter handling for the Equalizer network implementation. More...

#include <global.h>

Collaboration diagram for eq::net::Global:
Collaboration graph
[legend]

List of all members.

Static Public Member Functions

static void setProgramName (const std::string &programName)
 Sets the name of the program.
static const std::string & getProgramName ()
static void setWorkDir (const std::string &workDir)
 Sets the working directory of the program.
static const std::string & getWorkDir ()
static void setDefaultPort (const uint16_t port)
 Sets the default listening port.
static uint16_t getDefaultPort ()
static void setObjectBufferSize (const uint32_t size)
 Set the minimum buffer size for Object serialization.
static uint32_t getObjectBufferSize ()

Attributes



enum  IAttribute {
  IATTR_INSTANCE_CACHE_SIZE, IATTR_RSP_ACK_TIMEOUT, IATTR_RSP_MAX_TIMEOUTS, IATTR_RSP_NACK_DELAY,
  IATTR_RSP_ERROR_BASE_RATE, IATTR_RSP_ERROR_DOWNSCALE, IATTR_RSP_ERROR_UPSCALE, IATTR_RSP_ERROR_MAX,
  IATTR_RSP_NUM_BUFFERS, IATTR_UDP_MTU, IATTR_UDP_PACKET_RATE, IATTR_ALL
}
 

Global integer attributes.

More...
static void setIAttribute (const IAttribute attr, const int32_t value)
 Set an integer attribute.
static int32_t getIAttribute (const IAttribute attr)

Detailed Description

Global parameter handling for the Equalizer network implementation.

Definition at line 33 of file lib/net/global.h.


Member Enumeration Documentation

Global integer attributes.

Enumerator:
IATTR_INSTANCE_CACHE_SIZE 

For internal use only.

max size in MB

IATTR_RSP_ACK_TIMEOUT 

For internal use only.

time out for ack req

IATTR_RSP_MAX_TIMEOUTS 

For internal use only.

timeouts before close

IATTR_RSP_NACK_DELAY 

For internal use only.

sleep before nack merge

IATTR_RSP_ERROR_BASE_RATE 

For internal use only.

normal error percentage

IATTR_RSP_ERROR_DOWNSCALE 

For internal use only.

send rate down scale (/)

IATTR_RSP_ERROR_UPSCALE 

For internal use only.

send rate up scale (*)

IATTR_RSP_ERROR_MAX 

For internal use only.

max delta for send rate

IATTR_RSP_NUM_BUFFERS 

For internal use only.

data buffers

IATTR_UDP_MTU 

For internal use only.

max send size on UDP

IATTR_UDP_PACKET_RATE 

For internal use only.

ack frequency

Definition at line 86 of file lib/net/global.h.


Member Function Documentation

void eq::net::Global::setProgramName ( const std::string &  programName  )  [static]

Sets the name of the program.

Parameters:
programName the program name.

Definition at line 75 of file lib/net/global.cpp.

static const std::string& eq::net::Global::getProgramName (  )  [inline, static]
Returns:
the program name.

Definition at line 44 of file lib/net/global.h.

Referenced by eq::AGLEventHandler::initMagellan().

Here is the caller graph for this function:

void eq::net::Global::setWorkDir ( const std::string &  workDir  )  [static]

Sets the working directory of the program.

Parameters:
workDir the working directory.

Definition at line 79 of file lib/net/global.cpp.

static const std::string& eq::net::Global::getWorkDir (  )  [inline, static]
Returns:
the working directory of the program.

Definition at line 54 of file lib/net/global.h.

static void eq::net::Global::setDefaultPort ( const uint16_t  port  )  [inline, static]

Sets the default listening port.

Parameters:
port the default port.

Definition at line 61 of file lib/net/global.h.

static uint16_t eq::net::Global::getDefaultPort (  )  [inline, static]
Returns:
the default listening port.

Definition at line 65 of file lib/net/global.h.

Referenced by eq::net::Node::initLocal().

Here is the caller graph for this function:

static void eq::net::Global::setObjectBufferSize ( const uint32_t  size  )  [inline, static]

Set the minimum buffer size for Object serialization.

The buffer size is used during serialization. When a DataOStream has buffered at least size bytes, the data is send to the slave nodes. The default is 60.000 bytes.

Parameters:
size the treshold before the DataOStream sends a buffer.

Definition at line 76 of file lib/net/global.h.

static uint32_t eq::net::Global::getObjectBufferSize (  )  [inline, static]
Returns:
the minimum buffer size for Object serialization.

Definition at line 80 of file lib/net/global.h.

Referenced by eq::net::DataOStream::write().

Here is the caller graph for this function:

static void eq::net::Global::setIAttribute ( const IAttribute  attr,
const int32_t  value 
) [inline, static]

Set an integer attribute.

Definition at line 103 of file lib/net/global.h.

static int32_t eq::net::Global::getIAttribute ( const IAttribute  attr  )  [inline, static]
Returns:
the value of an integer attribute.

Definition at line 107 of file lib/net/global.h.

Referenced by eq::net::RSPConnection::RSPConnection(), and eq::net::UDPConnection::UDPConnection().

Here is the caller graph for this function:


The documentation for this class was generated from the following files:
Generated on Sat Feb 6 13:09:24 2010 for Equalizer 0.9.1 by  doxygen 1.6.1