SocketInterface Class Reference

#include <ClientServerUtils.h>

List of all members.

Public Types
enum	{ MaxChunkSize = MAXLINE }
Public Member Functions
	SocketInterface (int portNum, int timeOutSeconds=10000)
void	setTimeOut (int timeOutSeconds)
void	getAtLeast (int numBytes)
template<typename T>
void	sendStruct (T *ptr)
void	copy (char *target, int numBytes)
template<typename T>
void	receiveStruct (T *ptr)
void	checkSocketEmpty (void)
void	sendSequence (const WordSequence &seq)
void	receiveSequence (WordSequence &seq)
void	sendString (const string &s)
void	sendChars (const char *pChar, int numChars)
void	receiveString (string &s)
void	receiveChars (vector< char > &v)
Protected Attributes
int	portNum_
int	bytesRead_
int	bytesSent_
timeval	timeOut_
char	buffer_ [MAXLINE]

---

Detailed Description

Definition at line 225 of file ClientServerUtils.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

MaxChunkSize

Definition at line 234 of file ClientServerUtils.h.

{ MaxChunkSize=MAXLINE };

---

Constructor & Destructor Documentation

SocketInterface::SocketInterface	(	int	portNum,
		int	timeOutSeconds = 10000
	)			[inline]

Definition at line 228 of file ClientServerUtils.h.

References timeOut_.

                                                           : 
    portNum_( portNum ), bytesRead_(0), bytesSent_(0) 
    {
      timeOut_.tv_sec  = timeOutSeconds;
      timeOut_.tv_usec = 0;
    }

---

Member Function Documentation

void SocketInterface::setTimeOut

(

int

timeOutSeconds

)

[inline]

Definition at line 236 of file ClientServerUtils.h.

References timeOut_.

Referenced by sendQuery().

                                        {
    timeOut_.tv_sec = timeOutSeconds;
  }

Here is the caller graph for this function:

void SocketInterface::getAtLeast

(

int

numBytes

)

Definition at line 483 of file ClientServerUtils.cpp.

References buffer_, MaxChunkSize, portNum_, and timeOut_.

Referenced by copy().

{

  //  cout << "  getAtLeast " << numBytes << " bytes\n";

  int numRead(0);
  int totalNumRead(0); 
  int numTries(0);
  fd_set fds;
  FD_ZERO(&fds);
  FD_SET(portNum_, &fds);
  
  while(1)
  {
    // bit of a cheat using numRead twice here ...
    numRead=select(portNum_+1, &fds, NULL, NULL, &timeOut_ );
    if (numRead==0)
    {
      throw NetworkException
        ("Timed out getting data from socket: " + (string)strerror(errno) ); 
    } // ~if
    else if (numRead<0)
    {
      throw NetworkException
        ("Select error getting data from socket: " + (string)strerror(errno) ); 
    } // ~else if

    //    numRead=read(portNum_,(void*)&buffer_[0],MaxChunkSize);
    numRead=recv(portNum_,(void*)&buffer_[0],MaxChunkSize,0);
    if (numRead==0)
    {
      if (++numTries==100)
      throw NetworkException
        ("Reading zero bytes from socket, probable peer disconnect: " 
         + (string)strerror(errno) ); 
    }    
    if ( numRead < 0 )
    {
      if (errno==EINTR) continue;
      else 
      {
        //      throw NetworkException("getAtLeast error");
        throw NetworkException
        ( (string)"getAtLeast error: " + (string)strerror(errno) ); 
      } // ~else
    } // ~if
    //    cout << " got " << numRead << " so far...\n";
    insert(end(),&buffer_[0],&buffer_[numRead]);
    totalNumRead +=numRead;
    if (totalNumRead>=numBytes) break;

  } // ~while

  //  cout << "  total got " << totalNumRead << endl;

}

Here is the caller graph for this function:

template<typename T>

void SocketInterface::sendStruct

(

T *

ptr

)

[inline]

Definition at line 242 of file ClientServerUtils.h.

References bytesSent_, portNum_, and Writen().

Referenced by processQuery(), MatchTaskServer::sendMatches(), sendQuery(), and sendSequence().

  {
    bytesSent_+= sizeof(T);
    Writen(portNum_, (void*) ptr, sizeof(T) );
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketInterface::copy	(	char *	target,
		int	numBytes
	)

Definition at line 472 of file ClientServerUtils.cpp.

References getAtLeast().

Referenced by receiveSequence(), and receiveStruct().

{
  //  cout << "copy - requested " << numBytes << ", got " << size() << endl;
  if (size()<numBytes) getAtLeast(numBytes-size());

  for( int i(0) ; i < numBytes ; ++ i )
    { *target++ = front(); pop_front(); }

  //  cout << "final size " << size() << endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T>

void SocketInterface::receiveStruct

(

T *

ptr

)

[inline]

Definition at line 250 of file ClientServerUtils.h.

References copy().

Referenced by processQuery(), receiveChars(), receiveSequence(), receiveString(), and sendQuery().

  {
    copy( (char*)ptr, sizeof(T));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketInterface::checkSocketEmpty

(

void

)

Definition at line 437 of file ClientServerUtils.cpp.

References buffer_, MAXLINE, and portNum_.

Referenced by processQuery(), and sendQuery().

{
  
  //  Linux and other Unixes doesn't have MSG_NONBLOCK as an argument to recv. Workaround by DJC.
  

  //  Is the socket blocking at the moment?
  bool blocking;
  
  int flags=fcntl(portNum_,F_GETFL,0);
  int newflags=flags;

  if (flags==-1) 
    throw NetworkException("Problem reading status (fcntl) of socket");
  

  // Make it non-blocking
  newflags|=O_NONBLOCK;
  fcntl(portNum_,F_SETFL,newflags);

  // See if we can read data
  int n(recv( portNum_, buffer_, MAXLINE, MSG_PEEK));
 
  // Put the socket back to how it was before (blocking or non-blocking)
  fcntl(portNum_,F_SETFL,flags); 

  //perror("error status = ");
  if (errno!=EWOULDBLOCK) 
    {
      //    cout << "There are " << n << " bytes waiting to be read.\n";
      if (n>0) throw NetworkException("Unexpected data at socket!");
    }

}

Here is the caller graph for this function:

void SocketInterface::sendSequence

(

const WordSequence &

seq

)

Definition at line 350 of file ClientServerUtils.cpp.

References SequenceHeader::basesInLast, WordSequence::getNumBasesInLast(), portNum_, sendStruct(), SequenceHeader::size, and Writen().

Referenced by sendQuery().

{
    SequenceHeader sinfo;
    sinfo.size = seq.end() - seq.begin();
    sinfo.basesInLast = seq.getNumBasesInLast();

    sendStruct(&sinfo);
    Writen(portNum_, (void*)&(*seq.begin()), sinfo.size*sizeof(Word));

    //    bytesSent_+=sinfo.size*sizeof(Word)+sizeof(sinfo);
    //   cout << "@sent seq " << sinfo.size*sizeof(Word)+sizeof(sinfo) 
    //   << " bytes, " << bytesSent_ << "total.\n";

}

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketInterface::receiveSequence

(

WordSequence &

seq

)

Definition at line 366 of file ClientServerUtils.cpp.

References SequenceHeader::basesInLast, bytesRead_, copy(), receiveStruct(), WordSequence::setNumBasesInLast(), and SequenceHeader::size.

Referenced by processQuery().

{
  SequenceHeader sinfo;
  receiveStruct(&sinfo);
  //  cout << "receiveSeq: " << sinfo.size << " " << sinfo.basesInLast << endl;
  seq.resize(sinfo.size);

  copy((char*)&(*seq.begin()), sinfo.size*sizeof(Word));
  seq.setNumBasesInLast(sinfo.basesInLast);

  bytesRead_+=sinfo.size*sizeof(Word)+sizeof(sinfo);
  //  cout << "@read seq " << sinfo.size*sizeof(Word)+sizeof(sinfo) 
  //       << " bytes, " << bytesRead_ << "total.\n";
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketInterface::sendString

(

const string &

s

)

Definition at line 381 of file ClientServerUtils.cpp.

References bytesSent_, portNum_, and Writen().

Referenced by MatchTaskServer::sendMatches().

{
  Writen(portNum_, (void*)(s.c_str()), s.size()+1);
  bytesSent_+=s.size()+1;
  //  cout << "@send string " << s.size()+1 << " bytes, " << bytesSent_
  //     << "total.\n";
  // +1 cos we need to send the \0 at the end of the string
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketInterface::sendChars	(	const char *	pChar,
		int	numChars
	)

Definition at line 390 of file ClientServerUtils.cpp.

References bytesSent_, portNum_, and Writen().

Referenced by MatchTaskServer::sendMatches().

{
  static const char c('\0');
  Writen(portNum_, (void*)pChar, numChars);
  Writen(portNum_, (void*)&c, 1);
  bytesSent_+=numChars+1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketInterface::receiveString

(

string &

s

)

Definition at line 399 of file ClientServerUtils.cpp.

References receiveStruct().

Referenced by sendQuery().

{
  s="";
  char c;
  while(1)
  {
    receiveStruct(&c);
    if((c=='\0')||(c=='\n')) return;
    s+=c;
  } 
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketInterface::receiveChars

(

vector< char > &

v

)

Definition at line 411 of file ClientServerUtils.cpp.

References receiveStruct().

{
  v.clear();
  char c;
  while(1)
  {
    receiveStruct(&c);
    if((c=='\0')||(c=='\n')) return;
    v.push_back(c);
  } 
}

Here is the call graph for this function:

---

Member Data Documentation

int SocketInterface::portNum_ [protected]

Definition at line 268 of file ClientServerUtils.h.

Referenced by checkSocketEmpty(), getAtLeast(), sendChars(), sendSequence(), sendString(), and sendStruct().

int SocketInterface::bytesRead_ [protected]

Definition at line 269 of file ClientServerUtils.h.

Referenced by receiveSequence().

int SocketInterface::bytesSent_ [protected]

Definition at line 270 of file ClientServerUtils.h.

Referenced by sendChars(), sendString(), and sendStruct().

timeval SocketInterface::timeOut_ [protected]

Definition at line 272 of file ClientServerUtils.h.

Referenced by getAtLeast(), setTimeOut(), and SocketInterface().

char SocketInterface::buffer_[MAXLINE] [protected]

Definition at line 273 of file ClientServerUtils.h.

Referenced by checkSocketEmpty(), and getAtLeast().

---

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

• EnsemblServer/ClientServerUtils.h
• EnsemblServer/ClientServerUtils.cpp

---