クラス rcsc::BasicClient

standard soccer clientt class [詳細]

#include <basic_client.h>

すべてのメンバ一覧

Public 型

enum  { MAX_MESG = 8192 }

Public メソッド

 BasicClient ()
 init member variables
virtual ~BasicClient ()
 virtual destructor.
bool connectTo (const char *hostname, const int port, const long &interval_msec)
 connect to the specified server with timeout value for select()
void run (SoccerAgent *agent)
 program mainloop
void setIntervalMSec (const long &interval_msec)
 set new interval time for select()
void setServerAlive (const bool alive)
 set server status
int setCompressionLevel (const int level)
 set gzip compression level
int sendMessage (const char *msg)
 send raw string to the server
int recvMessage ()
 receive server message in the socket queue
bool isServerAlive () const
 check server alive status
const char * message () const
 get recieved message buffer


説明

standard soccer clientt class

This class supplies:


列挙型

anonymous enum

列挙型の値:
MAX_MESG  max length of send/receive buffer.


関数

bool rcsc::BasicClient::connectTo ( const char *  hostname,
const int  port,
const long &  interval_msec 
)

connect to the specified server with timeout value for select()

引数:
hostname server host name
port server port number
interval_msec timeout interval for select() by milli second
戻り値:
true if connection is created.

void rcsc::BasicClient::run ( SoccerAgent agent  ) 

program mainloop

Thie method keep infinite loop while client can estimate server is alive. To handle server message, select() is used. Timeout interval of select() is specified by M_interval_msec member variable. When server message is received, handleMessage() is called. When timeout occurs, handleTimeout() is called. When server is not alive, loop is end and handleExit() is called.

void rcsc::BasicClient::setIntervalMSec ( const long &  interval_msec  ) 

set new interval time for select()

引数:
interval_msec new interval by milli second

void rcsc::BasicClient::setServerAlive ( const bool  alive  ) 

set server status

引数:
alive server status flag. if server is dead, this value becomes false.

int rcsc::BasicClient::setCompressionLevel ( const int  level  ) 

set gzip compression level

引数:
level compression level
戻り値:
old compression level

int rcsc::BasicClient::sendMessage ( const char *  msg  ) 

send raw string to the server

引数:
msg message to be sent
戻り値:
result of sendto()

int rcsc::BasicClient::recvMessage (  ) 

receive server message in the socket queue

戻り値:
length of received message

bool rcsc::BasicClient::isServerAlive (  )  const [inline]

check server alive status

戻り値:
true if client can estimate server is alive

const char* rcsc::BasicClient::message (  )  const [inline]

get recieved message buffer

戻り値:
const pointer to the message buffer


このクラスの説明は次のファイルから生成されました:
librcscに対してThu May 1 15:41:25 2008に生成されました。  doxygen 1.5.0