Menu
▾
▴
[Nscldaq-cvscommits] SF.net SVN: nscldaq:[2408] trunk/llnlReadout/vmusb
|
From: <ro...@us...> - 2010-11-24 11:57:17
|
Revision: 2408
http://nscldaq.svn.sourceforge.net/nscldaq/?rev=2408&view=rev
Author: ron-fox
Date: 2010-11-24 11:57:08 +0000 (Wed, 24 Nov 2010)
Log Message:
-----------
Start adding remote client support for TclServer's VMUSB module.
Modified Paths:
--------------
trunk/llnlReadout/vmusb/Makefile.am
Added Paths:
-----------
trunk/llnlReadout/vmusb/CSocket.cpp
trunk/llnlReadout/vmusb/CSocket.h
trunk/llnlReadout/vmusb/CTCPBadSocketState.cpp
trunk/llnlReadout/vmusb/CTCPBadSocketState.h
trunk/llnlReadout/vmusb/CTCPConnectionFailed.cpp
trunk/llnlReadout/vmusb/CTCPConnectionFailed.h
trunk/llnlReadout/vmusb/CTCPConnectionLost.cpp
trunk/llnlReadout/vmusb/CTCPConnectionLost.h
trunk/llnlReadout/vmusb/CTCPNoSuchHost.cpp
trunk/llnlReadout/vmusb/CTCPNoSuchHost.h
trunk/llnlReadout/vmusb/CTCPNoSuchService.cpp
trunk/llnlReadout/vmusb/CTCPNoSuchService.h
trunk/llnlReadout/vmusb/CVMUSBRemote.cpp
trunk/llnlReadout/vmusb/CVMUSBRemote.h
trunk/llnlReadout/vmusb/ErrnoException.cpp
trunk/llnlReadout/vmusb/ErrnoException.h
trunk/llnlReadout/vmusb/Exception.cpp
trunk/llnlReadout/vmusb/Exception.h
trunk/llnlReadout/vmusb/histotypes.h
Added: trunk/llnlReadout/vmusb/CSocket.cpp
===================================================================
--- trunk/llnlReadout/vmusb/CSocket.cpp (rev 0)
+++ trunk/llnlReadout/vmusb/CSocket.cpp 2010-11-24 11:57:08 UTC (rev 2408)
@@ -0,0 +1,1349 @@
+/*
+ This software is Copyright by the Board of Trustees of Michigan
+ State University (c) Copyright 2008
+
+ You may use this software under the terms of the GNU public license
+ (GPL). The terms of this license are described at:
+
+ http://www.gnu.org/licenses/gpl.txt
+
+ Author:
+ Ron Fox
+ NSCL
+ Michigan State University
+ East Lansing, MI 48824-1321
+*/
+
+
+static const char* Copyright= "(C) Copyright Michigan State University 2002, All rights reserved";
+/*!
+ Encapsulates a generalized TCP/IP SOCK_STREAM
+ socket.
+ Note that TCP/IP Sockets can come in two flavors:
+ Clients and Servers. Clients must perform a connect,
+ while servers perform a bind, listen and then serveral
+ accepts to create 'server instances'.
+ The state of a socket is maintained in the m_State
+ variable and is from the enumerator:
+ CSocket::State
+
+ Disconnected - The socket is not connected to anything.
+ Bound - The socket is a server socket which is
+ not connected, but has been bound to
+ a service port.
+ Listening - The socket is a server port which is
+ listening and can therefore accept
+ connections
+ Connected - The socket is either a client or a
+ server instance and is connected
+ to it's counterpart.
+
+*/
+
+// Synchronization assumptions:
+// the (2) socket calls are recursive (threadsafe).
+// the (3) network database calls are not recursive (notthreadsafe).
+// as such, any calls to (3) network database calls are bracketed with
+// calls to globally synchronize the thread.
+/*! \bug Perhaps global syncronization of (3) calls should be conditionalized
+ so that this module can be used in a non spectrodaq environment too.
+ */
+
+////////////////////////// FILE_NAME.cpp /////////////////////////////////////////////////////
+
+#include <config.h>
+#include "CSocket.h"
+
+// Exception classes required:
+
+#include <CTCPNoSuchHost.h>
+#include <CTCPNoSuchService.h>
+#include <CTCPBadSocketState.h>
+#include <CTCPConnectionFailed.h>
+#include <ErrnoException.h>
+#include <CTCPConnectionLost.h>
+
+// Standard and network library headers.
+
+#include <unistd.h>
+#include <stdio.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/time.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <netdb.h>
+#include <string.h>
+
+#include <sys/poll.h>
+
+
+// STL includes.
+
+#include <vector>
+
+#ifdef HAVE_STD_NAMESPACE
+using namespace std;
+#endif
+
+// Manifest constannts:
+
+#ifndef TRUE
+#define TRUE 1
+#endif
+#ifndef FALSE
+#define FALSE 0
+#endif
+
+// Static members:
+
+map<CSocket::State, string> CSocket::m_StateNames;
+
+/*!
+ The default constructor initializes the fd to an illegal value
+ and sets the state to Disconnected.
+ The body of the constructor attempts to set the m_Fd member via a call to
+ socket(2) to create an INET domain SOCK_STREAM, protocl tcp.
+
+ It is up to the user to call Connect
+ or alternatively set up the socket as a server by binding and listening.
+
+ Exceptions:
+
+ - CErrnoException if getprotoent for tcp fails or if the socket call itself
+ fails.
+
+ */
+CSocket::CSocket ()
+ : m_Fd(-1),
+ m_State(Disconnected)
+
+{
+ OpenSocket();
+}
+
+/*!
+ Destructor action depends on the state:
+ sockets which are Connected are shutdown and then closed.
+ Sockets which are in other states are just closed if the fd > 0.
+ */
+CSocket::~CSocket ( ) //Destructor - Delete dynamic objects
+{
+ if(m_State == Connected) {
+ Shutdown();
+ }
+ if(m_Fd > 0) {
+ close(m_Fd);
+ }
+}
+
+/*!
+ This parameterized constructor is intended to allow a program which already
+ has created a socket in some arbitrary state to wrap it inside a CSocket
+ object. It must be used with care.. in the sense that the am_State
+ parameter must match the actual socket state.
+
+ \param am_Fd The file descriptor already open on a socket.
+ \param am_State The current state of the socket am_Fd
+
+ */
+CSocket::CSocket ( int am_Fd, CSocket::State am_State ) :
+ m_Fd(am_Fd),
+ m_State(am_State)
+
+{
+ StockStateMap(); // Ensure the statename map is stocked.
+}
+
+// Functions for class CSocket
+
+/*!
+ Operation Type:
+ Connection Control
+
+
+Indicates that the socket will be used
+as a client socket and attempts to connect it
+to a server.
+The address of the server can be
+passed in either in IP address or
+IP name textual format. Similarly,
+the port can be passed in as a textual
+port name (in /etc/services) or a port number.
+
+The action of this function is to convert (if possible) the Host and service
+into numeric equivalents and call the overloaded
+Connect(int IpAddress, int service)
+
+Exceptions which can be thrown:
+
+- CTCPBadSocketState -- m_State was not Disconnected
+- CTCPNoSuchHost - Host not in DNS or nonexistent.
+- CTCPNoSuchService - Named service does not translate.
+- CTCPConnectionFailed- Connection refused by remote host (from
+ Connect(int IpAddress, int service).
+
+\param host Specifies the system to connect to. This can be either a DNS
+ textual name or a string in dotted IP address format.
+\param service Specifies a service offered by the host. This can be either
+ a service name or the textual equivalent of a service number.
+
+On Success the socket state is set to Connected.
+
+*/
+void
+CSocket::Connect(const string& host, const string& service)
+{
+ // We must be disconnected to do any of this...
+
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Disconnected);
+
+ if(m_State != Disconnected) throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::Connect");
+
+ // If the host is a dotted ip number just translate it.. otherwise
+ // try to resolve the name:
+
+ unsigned long int ipaddr;
+ struct hostent* pEntry;
+
+ { // (3) calls not threadsafe.
+ ipaddr = inet_addr(host.c_str());
+ if(ipaddr == INADDR_NONE) { // Need to translate the name...
+ pEntry = gethostbyname(host.c_str());
+ if(pEntry) memcpy(&ipaddr, pEntry->h_addr, 4);
+ } // <-- End Critical region
+ if(!pEntry) throw CTCPNoSuchHost(host,
+ "Null return from gethostbyname(3)");
+ }
+ // Next resolve the service name... this can be either a number or a
+ // service name. Note that the port number is in the service database
+ // in network byte order.
+
+ unsigned short port = Service(service);
+
+
+ // Now we have everything we need to do call 'the other' Connect.
+
+ Connect(ntohl(ipaddr), ntohs(port));
+}
+
+/*!
+ Connects a socket as a client given numerical host, and port numbers in
+ host byte order. For the host that means that an ip address of form:
+
+ aa.bb.cc.dd is stored Hi->Low as aabbccdd in a longword.
+
+ See Connect(const string&host, const string& service) for more information.
+
+ \param IpAddress The numerical ip address of the server in host byte order.
+ \param service The port number of the service.
+ */
+
+void
+CSocket::Connect(unsigned long int IpAddress, unsigned short service)
+
+{
+ // Must be disconnected:
+
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Disconnected);
+
+ if(m_State != Disconnected) throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::Connect");
+
+ // Both the ip address and service must be in network byte order to be
+ // acceptable to connect(2).
+
+ IpAddress = htonl(IpAddress);
+ service = htons(service);
+
+ // Build the socket peer address structure.
+
+ sockaddr_in Peer;
+ Peer.sin_port = service;
+ memcpy(&(Peer.sin_addr), &IpAddress, sizeof(unsigned long int));
+ Peer.sin_family = AF_INET;
+
+ // Try the connect.
+
+ if(connect(m_Fd, (const sockaddr*)&Peer, sizeof(sockaddr_in)) < 0) {
+ int sErrno = errno;
+ string Ip, Svc;
+ {
+ char port[50];
+ Ip = inet_ntoa(Peer.sin_addr);
+ sprintf(port,"%d", ntohs(service));
+ Svc = port;
+
+ }
+ errno = sErrno; // sprintf e.g. destroys errno.
+ throw CTCPConnectionFailed(Ip, Svc,
+ "CSocket::Connect client connect(2) failed");
+ }
+
+ m_State = Connected;
+
+
+}
+
+/*!
+
+
+Indicates that the socket will be used
+as a server listener socket, and binds it
+to a service port. The service can be
+provided either as a numerical string
+or as a string translated via getservbyname().
+
+The following exceptions can be thrown:
+
+- CTCPBadSocketState m_State != Disconnected
+- CTCPNoSuchService Service could not be determined.
+- CErrnoException bind(2) failed.
+
+On success, m_State = Bound
+
+*/
+void
+CSocket::Bind(const string& service)
+{
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Disconnected);
+ if(m_State != Disconnected) throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::Bind");
+
+ // Determine the service in network byte order.
+
+ unsigned short port = Service(service);
+
+
+ // Now bind the socket.
+
+ sockaddr_in Peer;
+ Peer.sin_port = port;
+ Peer.sin_family = AF_INET;
+ Peer.sin_addr.s_addr = htonl(INADDR_ANY);
+
+ if(bind(m_Fd, (sockaddr*)&Peer, sizeof(sockaddr_in)) < 0) {
+ throw CErrnoException("Error from bind(2) in CSocket::Bind()");
+ }
+ m_State = Bound;
+
+}
+
+/*!
+
+Indicates that the specified server
+listener socket is ready to listen
+for connections.
+
+The Following exceptions can be
+thrown:
+
+- CTCPBadSocketState - m_State != Bound
+- CErrnoException - listen(2) failed.
+
+On success, m_State = Listening
+
+\param nBacklog The limit on the queue size for incomming connections.
+ This value of this parameter defaults to 5. If a
+ a connection is requested when the listen queue is full, it
+ is refused or allowed to retry depending on the protocol
+ (according to linux man connect(2)). On some systems this
+ parameter may be ignored or have other meaning.
+*/
+void
+CSocket::Listen(unsigned int nBacklog)
+{
+ // Throw CTCPBadSocketState if not bound:
+
+ if(m_State != Bound) {
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Bound);
+ throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::Listen");
+ }
+ if(listen(m_Fd, nBacklog) < 0)
+ throw CErrnoException("CSocket::Listen listen(2) failed");
+
+ m_State = Listening;
+}
+
+/*!
+
+This member function can be called on
+a server socket. The calling thread is blocked
+until a connection request is received. At that
+time, the connection is accepted (granted),
+and a new CSocket is created in the Connected
+state. The new CSocket represents a Server
+Instance socket, communication along that
+socket can take place immediately and will
+represent communication with the client.
+
+Exceptions which can be thrown:
+
+- CTCPBadSocketState m_State != Listening
+- CErrnoException accept(2) call failed.
+
+Side effects:
+
+The client parameter is
+written with a string representing the
+hostname of the client or the IP address
+if the hostname can not be determined.
+
+The socket created is created via new, therefore
+it is the responsibility of the caller to delete it.
+
+\param client Recieves the IP information of the connecting host.
+ Where possible, this is the hostname. Where not, a dotted IP
+ address.
+
+*/
+CSocket*
+CSocket::Accept(string& client)
+{
+ // Throw CTCPBadSocket if not listening.
+
+ if(m_State != Listening) {
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Listening);
+ throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::Accept");
+ }
+
+ // Attempt the accept. If successfule, the return
+ // value will be a socket fd.
+
+ struct sockaddr_in peerInfo;
+ socklen_t addrlen(sizeof(sockaddr_in));
+ int peerFd = accept(m_Fd, (sockaddr*)&peerInfo, &addrlen);
+ if(peerFd < 0) {
+ throw CErrnoException("CSocket::Accept accept(2) failed");
+ }
+
+ // At this time we have received a good connection. There are two things
+ // we need to do:
+ // 1. Construct a new CSocket in the connected state.
+ // 2. Figure out and fill in the client:
+
+ CSocket* pConnection = new CSocket(peerFd, Connected);
+ client = AddressToHostString(peerInfo.sin_addr);
+
+ return pConnection;
+}
+
+/*!
+
+Purpose:
+
+ Shuts down a connection to a remote system.
+Unlike shutdown(2) this function does not support
+selectively shutting down reads or writes. Both are
+unconditionally shutdown.
+ Note that the destructor will automatically call Shutdown
+if necessary.
+
+Exceptions:
+- CTCPBadSocketState m_State != Connected.
+- CErrnoException shutdown(2) failed.
+
+*/
+void
+CSocket::Shutdown()
+{
+ // Require that the socket be connected.
+
+ if(m_State != Connected) {
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Connected);
+ throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::Shutdown");
+ }
+
+
+ if(shutdown(m_Fd, SHUT_RDWR) < 0) {
+ throw CErrnoException("CSocket::Shutdown failed in call to shutdown(2)");
+ }
+
+ m_State = Disconnected;
+ close(m_Fd);
+ m_Fd = -1; // Mark the socket closed.
+OpenSocket();
+}
+
+/*!
+
+Purpose:
+
+Performs a read on the socket. The read will transfer
+all of the bytes currently waiting in the socket buffers
+or block until data is avaialble. The return valiue will
+be the number of bytes transferred. If the connection
+is lost, CTCPConnectionLost will be thrown. Multiple reads will not be
+performed so that any known messaging structure can be maintained.
+
+Throws:
+- CErrnoException - the read(2) system service returned an error.
+- CTCPConnectionLost - the read(2) system service returned 0 indicating
+ an end of file condition.
+- CTCPBadSocketState - m_State != Connected.
+
+*/
+int
+CSocket::Read(void* pBuffer, size_t nBytes)
+{
+ // Require the socket be connected:
+
+ if(m_State != Connected) {
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Connected);
+ throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::Read()");
+ }
+ // Attempt the read:
+
+ int nB = read(m_Fd, pBuffer, nBytes);
+
+ // Check for EOF:
+
+ if(nB == 0) {
+ m_State = Disconnected;
+ shutdown(m_Fd, SHUT_RD | SHUT_WR);
+ close(m_Fd);
+ OpenSocket();
+ throw CTCPConnectionLost(this, "CSocket::Read: from read(2)");
+ }
+ // Check for error:
+
+ if(nB < 0) {
+ m_State = Disconnected;
+ throw CErrnoException("CSocket::Read failed read(2)");
+ }
+ // There's data to transfer.
+
+ return nB;
+}
+
+
+/*!
+
+Purpose:
+
+Writes data to the socket. Note that
+this member will block as needed until
+all data has been queued to the socket buffers.
+This may require multiple write(2) function calls
+if the amount of data to be written is larger than
+the socket's blocking factor. Note that if the connection
+is lost during the write, CTCPConnectionLost will be thrown.
+
+Exceptions:
+- CTCPBadSocketState m_State != Connected
+- CErrnoException write(2) returned an error condition.
+- CTCPConnectionLost write(2) indicated an EPIPE condition which says
+ the peer closed the socket.
+ \bug There's not a good way to handle failures on the second
+ or later call to write(2). Since we'd like to indicate that
+ part of the write completed before an error occured.
+ The current assumption is that a followup write will produce
+ the same error. Perhaps the best long term thing to do is to
+ define a CTCPSocketIOError which will include as data the
+ number of bytes written along with a CErrnoException which
+ describes why the write actually failed??
+
+
+*/
+int
+CSocket::Write(void* pBuffer, size_t nBytes)
+{
+ // Require that the socket is connected:
+
+
+
+ // write(2) as many times as are needed to get the data out.
+
+
+ char* p((char* )pBuffer); // Pointer to current write.
+ int resid(nBytes); // Number of remaining bytes to write.
+ int nWritten(0); // Number of bytes already written.
+
+ while(resid) {
+ int n = write(m_Fd, p, resid);
+ if(n > 0) { // Do the book-keeping for a successful write.
+ resid -= n;
+ nWritten += n;
+ p += n;
+ }
+ else { // Write failed:
+ if(nWritten > 0) { // Assume if not first write, additional
+ break; // Writes will give the same error.
+ }
+ if(errno == EPIPE) { // Disconnected.
+ m_State = Disconnected;
+ shutdown(m_Fd, SHUT_RD | SHUT_WR);
+ close(m_Fd);
+ OpenSocket();
+ throw CTCPConnectionLost(this,"CSocket::Write - first write of loop");
+ }
+ else { // Some other error:
+ m_State = Disconnected;
+ throw CErrnoException("CSocket::Write failed write(2)");
+ }
+ }
+ }
+ return nWritten; // Indicate how many bytes were actually
+ // written. If < nBytes something unusual
+ // occured in the loop above.
+}
+
+/*!
+
+Purpose:
+
+Returns information about who a socket
+is connected to. If the socket is not
+connected, CTCPBadSocketState is thrown.
+If possible, the peername parameter is returned
+as a string containing the DNS name of the
+peer. If the DNS lookup fails, the IP address
+is converted into dotted form.
+
+\param port The number of the port to which the socket is connected.
+\param peer The peer as either a DNS hostname or a dotted IP address.
+
+Throws:
+- CTCPBadSocketState if m_State != Connected
+- CErrnoException if getpeeername(2) failed.
+
+*/
+void
+CSocket::getPeer(unsigned short& port, string& peer)
+{
+ // Enforce connection requirement:
+
+ if(m_State != Connected) {
+ vector<CSocket::State> allowedStates;
+ allowedStates.push_back(Connected);
+ throw CTCPBadSocketState(m_State, allowedStates,
+ "CSocket::GetPeer");
+ }
+ // Try the call to getpeername(2):
+
+ sockaddr_in PeerInfo;
+ socklen_t addrsize(sizeof(sockaddr_in));
+ if(getpeername(m_Fd, (sockaddr*)&PeerInfo, &addrsize) < 0) {
+ throw CErrnoException("CSocket::getPeer failed call to getpeername(2)");
+ }
+ // Pull out the port in local host byte order, and translate the
+ // ip address:
+
+ port = ntohs(PeerInfo.sin_port);
+ peer = AddressToHostString(PeerInfo.sin_addr);
+
+}
+
+/*!
+
+Purpose:
+
+Allows Out Of Band (OOB) data to be inserted in line with buffered data.
+OOB data is data with a higher delivery priority than 'normal data'. If this
+flag is not set, then by default OOB data must be read through normal
+socket interface functions by specifying it in the recv flags parameter.
+If this flag is set, oob data is queue at the front of the data to be read
+with the Read member.
+
+This is allowed in any socket state.
+Exceptions:
+- CErrnoException if the setsockopt(2) function failed.
+
+\param State This can be (Defaults to TRUE):
+- TRUE Enables out of band inline data.
+- FALSE disables out of band inline data.
+
+*/
+void
+CSocket::OOBInline(bool State)
+{
+ int state((int)State);
+ if(setsockopt(m_Fd, SOL_SOCKET,
+ SO_OOBINLINE, (void*)&state, sizeof(int)) < 0) {
+ throw CErrnoException("CSocket::OOBInline setsockopt(2) failed");
+ }
+}
+
+/*!
+
+Purpose:
+
+Returns TRUE if OOBinline is set
+FALSE otherwise. Note that the underlying
+socket state is inquired, not some saved internal
+state.
+
+This function is valid in any socket state.
+
+Throws:
+- CErrnoException if getsockopt(2) fails
+.
+*/
+bool
+CSocket::isOOBInline()
+{
+ unsigned int state;
+ socklen_t size(sizeof(int));
+ if(getsockopt(m_Fd, SOL_SOCKET,
+ SO_OOBINLINE, (void*)&state, &size) < 0) {
+ throw CErrnoException("CSocket::OOBInline getsockopt(2) failed");
+ }
+ return state ? TRUE : FALSE;
+}
+
+/*!
+
+
+Purpose:
+
+Sets the Receive low water mark for the socket.
+This is the number of bytes received by the
+protocol before any is made available to the
+user. Note that some systems do not allow
+this to be changed. It is not an error at this
+level to attempt to do so, however you will need to
+call getRcvlowWaterMark to be sure the change was
+actually made.
+
+
+Throws:
+- CErrnoException if an error from setsockopt is detected other than that the
+ system doesn't support resetting the low water mark.
+
+*/
+void
+CSocket::setRcvLowWaterMark(size_t nBytes)
+{
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_RCVLOWAT, (void*)&nBytes, sizeof(size_t)) < 0) {
+ if (errno == ENOPROTOOPT) {
+ return; // Just not suppported is ok..
+ }
+ throw
+ CErrnoException("CSocket::setRcvLowWaterMark() setsockopt(2) failed");
+ }
+}
+
+
+/*!
+
+Returns the size of the current receive low water mark.
+See setRcvLowWaterMark for information about what this
+parameter does. Note that the value returned is inquired from
+the socket rather than stored in internal state.
+
+Throws:
+- CErrnoException if an error from getsockopt is detected.
+
+*/
+size_t
+CSocket::getRcvLowWaterMark()
+{
+ int nBytes;
+ socklen_t addrlen(sizeof(int));
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_RCVLOWAT, &nBytes, &addrlen) < 0) {
+ throw
+ CErrnoException("CSocket::getRcvLowWaterMark() getsockopt(2) failed");
+ }
+ return (size_t)nBytes;
+}
+
+/*!
+
+Sets the new value of the Send Low water mark.
+This controls the number of bytes which must be written
+before transferring data to the protocol layers for transmission.
+Note that some systems don't allow this value to be changed.
+It is not an error to attempt to change this value on those systems,
+however you should use getSndLowWaterMark to determine the
+actual value negotiated by the system.
+
+\param nBytes Number of bytes in the low water mark.
+
+Throws:
+- CErrnoException if an error from setsockopt is detected other than that the
+ system doesn't support resetting the low water mark.
+
+*/
+void
+CSocket::setSndLowWaterMark(size_t nBytes)
+{
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_SNDLOWAT, &nBytes, sizeof(size_t)) < 0) {
+ if (errno != ENOPROTOOPT) {
+ CErrnoException("CSocket::setSndLowWaterMark() setsockopt(2) failed");
+ }
+ }
+}
+/*!
+
+Return the value of the current Send Low Water Mark
+Set setSndLowWaterMarrk for more information.
+
+Throws:
+- CErrnoException if an error from getsockopt is detected.
+
+*/
+size_t
+CSocket::getSndLowWaterMark()
+{
+ int nBytes;
+ socklen_t adrlen(sizeof(int));
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_SNDLOWAT, &nBytes, &adrlen) < 0) {
+ throw
+ CErrnoException("CSocket::getRcvLowWaterMark() getsockopt(2) failed");
+ }
+ return (size_t)nBytes;
+}
+
+/*!
+
+Set the protocol receive timeouts. Note that in some systems,
+these are not settable. However it is not an error to attempt to do so.
+
+\param nMs number of milliseconds of timeout to set.
+
+Throws:
+- CErrnoException if a setsockopt(3) returns an error other than that this is
+ unsupported.
+*/
+void
+CSocket::setRcvTimeout(unsigned int nMs)
+{
+ //
+ // First convert the nMs parameter into a timeval.
+ //
+ timeval timeout;
+ timeout.tv_sec = nMs / 1000; // Number of seconds...
+ timeout.tv_usec = (nMs % 1000) * 1000; // Left over milliseconds in uSec.
+
+ // Now make the request:
+
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_RCVTIMEO,
+ &timeout, sizeof(timeval)) < 0) {
+ if(errno != ENOPROTOOPT) {
+ throw CErrnoException("CSocket::setRcvTimeout setsockopt(2) failed");
+ }
+ }
+}
+
+/*!
+
+Purpose:
+
+Retrieve the protocol receive timeout. The time out is returned as an integer
+number of milliseconds.
+
+Throws:
+- CErrnoException if getsockopt(3) returns an error.
+
+*/
+unsigned int
+CSocket::getRcvTimeout()
+{
+ timeval timeout;
+ socklen_t adrlen(sizeof(timeval));
+
+ // Get the timeout if possible:
+
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_RCVTIMEO,
+ &timeout, &adrlen) < 0) {
+ throw CErrnoException("CSocket::getRcvTimeout getsockopt(2) failed");
+ }
+ // Convert to ms and return.
+
+ int nMs = timeout.tv_sec*1000; + timeout.tv_usec/1000000;
+ return nMs;
+}
+
+/*!
+
+Purpose:
+
+Set the number of milliseconds in the send timeout.
+Some systems may not allow this to be set, however it is not
+an error to try.
+
+Throws:
+- CErrnoException if setsockop(2) returned an error other than this option is
+ not supported.
+
+\param nMs Number of milliseconds in the desired timeout.
+
+*/
+void
+CSocket::setSndTimeout(unsigned int nMs)
+{
+ // Convert timeout to a timeval structure:
+
+ timeval timeout;
+ timeout.tv_sec = nMs / 1000; // Number of seconds...
+ timeout.tv_usec = (nMs % 1000) * 1000; // Left over milliseconds in uSec.
+
+ // Now make the request:
+
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_SNDTIMEO,
+ &timeout, sizeof(timeval)) < 0) {
+ if(errno != ENOPROTOOPT) {
+ throw CErrnoException("CSocket::setRcvTimeout setsockopt(2) failed");
+ }
+ }
+}
+
+/*!
+Purpose:
+
+Returns the current send timeout in ms.
+
+Throws:
+- CErrnoException if there was an error in getsockopt(2).
+
+*/
+unsigned int
+CSocket::getSndTimeout()
+{
+ timeval timeout;
+ socklen_t adrlen(sizeof(timeval));
+
+ // Get the timeout if possible:
+
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_SNDTIMEO,
+ &timeout, &adrlen) < 0) {
+ throw CErrnoException("CSocket::getRcvTimeout getsockopt(2) failed");
+ }
+ // Convert to ms and return.
+
+ int nMs = timeout.tv_sec*1000; + timeout.tv_usec/1000000;
+ return nMs;
+}
+
+/*!
+
+Purpose:
+
+Attempts to turn on Socket debugging.
+To support this. The user must have effective
+UID = 0. .
+
+Throws:
+- CErrnoException if an error was returned from setsockopt(2) At present
+ we don't know of systems which don't implement this so
+ all errors will throw.
+
+\param fState [TRUE] Desired state of debugging. TRUE will cause
+ debugging to be turned on. FALSE turned off.
+*/
+void
+CSocket::Debug(bool fState)
+{
+ int state((int)fState);
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_DEBUG, &state, sizeof(int)) < 0) {
+ throw CErrnoException("CSocket::Debug setsockopt(2) failed");
+ }
+
+}
+
+/*!
+
+Purpose:
+
+Returns TRUE if socket debugging is
+turned on and False otherwise.
+
+Exceptions:
+- CErrnoException if an error is returned from the getsockopt(2) call.
+
+*/
+bool
+CSocket::isDebug()
+{
+ int fstate;
+ socklen_t adrlen(sizeof(int));
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_DEBUG, &fstate, &adrlen) < 0) {
+ throw CErrnoException("CSocket:Debug getsockopt(2) failed");
+ }
+ return fstate ? TRUE : FALSE;
+}
+
+/*!
+
+Purpose:
+
+Allows the caller to control the routability of messages
+sent on the socket. If set, messages will not
+be sent through a gateway.
+Note:
+ The socket need not be connected. Presumably,
+if this flag is set prior to Connect on a client socket
+the client will be unable to connect outside the local
+subnet, and if set prior to Bind for a server, the server will
+be unable to accept connections from outside the subnet.
+
+Exceptions:
+-CErrnoException if the setsockopt(2) call failed.
+
+\param fRoutable [TRUE] :
+- TRUE to turn OFF Routing
+- FALSE to turn ON Routing.
+
+*/
+void
+CSocket::SetNotRoutable(bool fRoutable)
+{
+ int state((int)fRoutable);
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_DONTROUTE, &state, sizeof(int)) < 0) {
+ throw CErrnoException("CSocket::SetNotRoutable setsockopt(2) failed");
+ }
+
+}
+
+/*!
+
+
+Purpose:
+
+Returns the state of the routability flag.
+
+Throws:
+- CErrnoException If getsockopt(2) failed.
+
+Return values:
+- TRUE Routing is turned off.
+- FALSE Routing is tured on.
+
+*/
+bool
+CSocket::isNotRoutable()
+{
+ int fState;
+ socklen_t adrlen(sizeof(int));
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_DONTROUTE, &fState, &adrlen) < 0) {
+ throw CErrnoException("CSocket::isNotRoutable getsockopt(2) failed");
+ }
+ return fState ? TRUE : FALSE;
+}
+
+/*!
+ \fn void CSocket::setSndBufSize(size_t nBufferSize)
+ Operation Type:
+ Configuration
+
+Purpose:
+
+Sets the socket send buffer size. This
+has to do with how many bytes can be
+sent in a single write(2) service call. Messages
+larger than that must be segmented into multiple
+write(2) calls. Note howerver that
+CTCPSocket::Write automatically handles
+any necessary segmentation.
+
+
+Throws:
+- CErrnoException if setsockopt(2) fails.
+
+\param nBufferSize Number of bytes which can be sent in one write(2) call
+
+*/
+void
+CSocket::setSndBufSize(size_t nBufferSize)
+{
+ unsigned int size((unsigned int)nBufferSize);
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_SNDBUF, &size, sizeof(int)) < 0) {
+ throw CErrnoException("CSocket::setSndBufSize setsockopt(2) failed");
+ }
+}
+
+/*!
+
+
+Purpose:
+
+Returns the number of bytes that can be
+written in a single write(2) call.
+
+Throws:
+- CErrnoException if getsockopt(2) fails.
+
+*/
+size_t
+CSocket::getSndBufSize()
+{
+ unsigned int size;
+ socklen_t adrlen(sizeof(int));
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_SNDBUF, &size, &adrlen) < 0) {
+ throw CErrnoException("CSocket::getSndBufSize getsockopt(2) failed");
+ }
+ return (size_t)size;
+}
+
+/*!
+
+
+
+Sets the maximum number of bytes which can be received in a single
+read(2) operation. Note that CTCPSocket::Read does >NOT<
+automatically segment or else you may block when you'd like
+to believe that a message has been received.
+
+\throw CErrnoException if setsockopt(2) fails.
+
+\param nBytes Number of bytes which can be sent in one write(2) call
+
+*/
+void
+CSocket::setRcvBufSize(size_t nBytes)
+{
+ unsigned int size = (unsigned int)nBytes;
+
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_RCVBUF, &size, sizeof(int)) < 0) {
+ throw CErrnoException("CSocket::setRcvBufSize setsockopt(2) failed");
+ }
+}
+
+/*!
+
+Purpose:
+
+Returns the maximum number of bytes which can be
+recieved in a single read(2) call.
+
+Throws:
+- CErrnoException if getsockopt(2) fails.
+
+
+*/
+size_t
+CSocket::getRcvBufSize()
+{
+ unsigned int size;
+ socklen_t adrlen(sizeof(int));
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_RCVBUF, &size, &adrlen) < 0) {
+ throw CErrnoException("CSocket::getSndBufSize getsockopt(2) failed");
+ }
+ return (size_t)size;
+}
+
+/*!
+Purpose:
+
+Sets the socket linger parameters. Linger properties
+govern the way a shutdown, operates. Note that
+object destruction which requires a shutdown implicitly
+turns off linger.
+ If linger is enabled, then the close will block until
+all pending data has been successfully sent or until the
+linger timeout is exceeded.
+
+Throws:
+- CErrnoException if the setsockopt(2) call failed.
+
+\param lOn Determines if linger is on or off:
+- TRUE Linger is on.
+- FALSE Linger is off.
+\param nLingerSeconds (only used if lOn is TRUE). Indicates how many seconds
+ to linger on the close until a timeout is declared and the
+ close unblocks.
+*/
+void
+CSocket::setLinger(bool lOn, int nLingerSeconds)
+{
+ // The linger structure is filled in the way it is so that the user could
+ // conceivably omit a timeout interval if lOn == FALSE since in that case,
+ // nLingerSeconds won't be referenced.
+
+ linger lInfo;
+ lInfo.l_onoff = lOn;
+ if(lOn) lInfo.l_linger = nLingerSeconds;
+
+ // Set the linger parameters:
+
+ if(setsockopt(m_Fd, SOL_SOCKET, SO_LINGER, &lInfo, sizeof(linger)) < 0) {
+ throw CErrnoException("CSocket::setLinger setsockopt(2) failed");
+ }
+}
+
+/*!
+Purpose:
+
+Retrieve the linger parameters.
+
+Throws:
+- CErrnoException if the setsockopt(2) call failed.
+
+\param isLingering [out] Receives the value of the linger state:
+- TRUE linger is enabled.
+- FALSE linger is not enabled.
+\param nLingerSeconds [out] Receives the value of the linger timeout. This
+ only has meaning in the event that isLingering == TRUE.
+
+
+*/
+void
+CSocket::getLinger(bool& isLingering, int& nLingerSeconds)
+{
+ linger linfo;
+ socklen_t addrlen(sizeof(linger));
+ if(getsockopt(m_Fd, SOL_SOCKET, SO_LINGER, &linfo, &addrlen) < 0) {
+ throw CErrnoException("CSocket::getLinger getsockopt(2) failed");
+ }
+
+ // Fill in the parameters from the linger structure:
+
+ isLingering = linfo.l_onoff;
+ nLingerSeconds = linfo.l_linger;
+}
+/*!
+ Purpose:
+ Determines the service which corresponds to a service string.
+ Service strings can either be a numerical equivalent of a service port
+ number or a service name which can be looked up in the service database.
+
+ \param rService The service name.
+
+ Returns: The port number or throws:
+ -CTCPNoSuchService The service cannot be translated.
+ */
+unsigned short
+CSocket::Service(const string& rService)
+{
+ unsigned short port;
+ int nport;
+
+ if(sscanf(rService.c_str(), "%d", &nport) != 1) { // Non numeric service number.
+ struct servent* pEntry;
+ { // getservbyname not recursive
+ pEntry = getservbyname(rService.c_str(), "tcp");
+ if(pEntry) port = pEntry->s_port;
+ }
+ if(!pEntry) throw CTCPNoSuchService(rService,
+ "Null return from getservbyname(3)");
+ }
+ else {
+ port = nport;
+ port = htons(port);
+ }
+ return port;
+}
+
+/*!
+ Purpose:
+ Given an IP address in in_addr format, returns a string describing
+ the address. First gethostbyaddr(3) is used to attempt to get the
+ primary DNS name of the address. If this fails, then inet_ntoa(3)
+ is called to get a dotted string.
+
+ \param peer - The network address of a host in in_addr, network byte order
+ form.
+
+ */
+string
+CSocket:: AddressToHostString(in_addr peer)
+{
+ string result;
+ {
+ struct hostent* pEntry = gethostbyaddr((const char*)&peer,
+ sizeof(in_addr), AF_INET);
+ if(pEntry) { // Reverse DNS worked...
+ result = pEntry->h_name;
+
+ }
+ else { // Need to return dotted address.
+ result = inet_ntoa(peer);
+ }
+ }
+
+ return result;
+}
+/*!
+ Purpose:
+ Given a state, returns a text string which describes the state.
+ \param state - State to describe.
+
+ NOTE: Since this is a static member which can be called before any
+ instances of CSocket have been created, we call StockStateMap().
+
+ */
+string
+CSocket::StateName(CSocket::State state)
+{
+ StockStateMap();
+ return m_StateNames[state];
+}
+/*!
+ Purpose:
+ Stocks the static member: m_StateNames with the states and their names.
+ This is only done if the map is empty. This function must be updated if
+ the set of states is modified.
+ */
+void
+CSocket::StockStateMap()
+{
+ if(!m_StateNames.empty()) {
+ m_StateNames[Disconnected] = "Disconnected";
+ m_StateNames[Bound] = "Bound";
+ m_StateNames[Listening] = "Listening";
+ m_StateNames[Connected] = "Connected";
+ }
+}
+/*!
+ Opens the socket on a TCP/IP endpoint.
+ */
+void
+CSocket::OpenSocket()
+{
+ int protocol;
+ struct protoent entry;
+ char entryFields[1024];
+ struct protoent* pEntry;
+ StockStateMap(); // Ensure the state name map is stocked.
+ int status;
+
+ status = getprotobyname_r("TCP", &entry, entryFields, sizeof(entryFields),
+ &pEntry);
+
+
+ if(!pEntry) throw
+ CErrnoException("Getting TCP protocol num from getprotoent(3)");
+
+ m_Fd = socket(PF_INET, SOCK_STREAM, protocol);
+ if(m_Fd == -1) throw
+ CErrnoException("Creating socket with socket(2)");
+
+}
+/*!
+ Flush buffered input from the socket.
+*/
+void
+CSocket::Flush()
+{
+ struct pollfd myfd;
+ myfd.fd = m_Fd;
+ myfd.events = POLLHUP | POLLIN;
+ myfd.revents = 0;
+ int result;
+ while(result = poll(&myfd,1, 0)) {
+ if(result < 0) { // probably disconnect...
+ return;
+ }
+ if(myfd.revents & POLLIN) {
+ char in;
+ Read(&in, 1); // Flush a character.
+ }
+ if(myfd.revents & POLLHUP) { // Probably disconnect...
+ return;
+ }
+ myfd.revents = 0;
+ }
+
+}
Property changes on: trunk/llnlReadout/vmusb/CSocket.cpp
___________________________________________________________________
Added: svn:executable
+ *
Added: trunk/llnlReadout/vmusb/CSocket.h
===================================================================
--- trunk/llnlReadout/vmusb/CSocket.h (rev 0)
+++ trunk/llnlReadout/vmusb/CSocket.h 2010-11-24 11:57:08 UTC (rev 2408)
@@ -0,0 +1,196 @@
+/*
+ This software is Copyright by the Board of Trustees of Michigan
+ State University (c) Copyright 2008
+
+ You may use this software under the terms of the GNU public license
+ (GPL). The terms of this license are described at:
+
+ http://www.gnu.org/licenses/gpl.txt
+
+ Author:
+ Ron Fox
+ NSCL
+ Michigan State University
+ East Lansing, MI 48824-1321
+*/
+
+
+// Author:
+// Ron Fox
+// NSCL
+// Michigan State University
+// East Lansing, MI 48824-1321
+// mailto:fo...@ns...
+//
+// Copyright
+// NSCL All rights reserved.
+//
+#ifndef __CSOCKET_H //Required for current class
+#define __CSOCKET_H
+
+//
+// Include files:
+//
+
+#ifndef __STL_STRING
+#include <string>
+#ifndef __STL_STRING
+#define __STL_STRING
+#endif
+#endif
+
+#ifndef __STL_MAP
+#include <map>
+#ifndef __STL_MAP
+#define __STL_MAP
+#endif
+#endif
+
+#ifndef __INET_IN_H
+#include <netinet/in.h>
+#define __INET_IN_H
+#endif
+
+#ifndef TRUE
+#define TRUE 1
+#endif
+
+
+/*!
+ Encapsulates a generalized TCP/IP SOCK_STREAM
+ socket.
+ Note that TCP/IP Sockets can come in two flavors:
+ Clients and Servers. Clients must perform a connect,
+ while servers perform a bind, listen and then serveral
+ accepts to create 'server instances'.
+ The state of a socket is maintained in the m_State
+ variable and is from the enumerator:
+ CSocket::State
+
+ - Disconnected: The socket is not connected to anything.
+ - Bound: The socket is a server socket which is
+ not connected, but has been bound to
+ a service port.
+ - Listening: The socket is a server port which is
+ listening and can therefore accept
+ connections
+ - Connected The socket is either a client or a
+ server instance and is connected
+ to it's counterpart.
+
+ */
+class CSocket
+{
+public:
+
+ //! Captures the state of the socket. See general remarks for more info
+ enum State {
+ Disconnected,
+ Bound,
+ Listening,
+ Connected
+ };
+
+private:
+
+ // Private Member data:
+ int m_Fd; //!< Socket
+ CSocket::State m_State; //!< State of socket.
+ static std::map<CSocket::State, std::string> m_StateNames; //!< State name lookup tbl.
+
+ // Public nested data types:
+
+
+
+public:
+ CSocket ();
+ CSocket ( int am_Fd, CSocket::State am_State ) ;
+
+ virtual ~CSocket ( );
+
+ //! Copy Constructor forbidden.
+private:
+ CSocket (const CSocket& aCSocket );
+
+ //! Assignment Operator Forbidden
+ CSocket& operator= (const CSocket& aCSocket);
+
+ //! Equality Operator Forbidden
+ int operator== (const CSocket& aCSocket) const;
+public:
+
+// Selectors:
+
+public:
+
+ //! Get accessor function socket file descriptor.
+ int getSocketFd() const
+ { return m_Fd;
+ }
+
+ //! Get accessor function for socket state.
+ CSocket::State getState() const
+ { return m_State;
+ }
+
+// Attribute mutators:
+
+protected:
+
+ //! Set accessor function for Socket file descriptor.
+ void setSocketFd(const int am_Fd)
+ { m_Fd = am_Fd;
+ }
+ //! Set accessor function for current socket state.
+ void setState (const CSocket::State am_State)
+ { m_State = am_State;
+ }
+
+ // Class operations:
+
+public:
+
+ void Connect (const std::string& host, const std::string& service);
+ void Connect (unsigned long int IpAddress, unsigned short service);
+ void Bind (const std::string& service) ;
+ void Listen (unsigned int nBacklog=5) ;
+ CSocket* Accept (std::string& client) ;
+ void Shutdown () ;
+ int Read (void* pBuffer, size_t nBytes) ;
+ int Write (void* pBuffer, size_t nBytes) ;
+ void getPeer (unsigned short& port, std::string& peer) ;
+ void OOBInline (bool State=TRUE) ;
+ bool isOOBInline () ;
+ void setRcvLowWaterMark (size_t nBytes) ;
+ size_t getRcvLowWaterMark () ;
+ void setSndLowWaterMark (size_t nBytes) ;
+ size_t getSndLowWaterMark () ;
+ void setRcvTimeout (unsigned int nMs) ;
+ unsigned int getRcvTimeout () ;
+ void setSndTimeout (unsigned int nMs) ;
+ unsigned int getSndTimeout () ;
+ void Debug (bool fState=TRUE) ;
+ bool isDebug () ;
+ void SetNotRoutable (bool fRoutable=TRUE) ;
+ bool isNotRoutable () ;
+ void setSndBufSize (size_t nBufferSize) ;
+ size_t getSndBufSize () ;
+ void setRcvBufSize (size_t nBytes) ;
+ size_t getRcvBufSize () ;
+ void setLinger (bool lOn, int nLingerSeconds) ;
+ void getLinger (bool& isLingering, int& nLingerSeconds) ;
+
+ static std::string StateName(CSocket::State state);
+
+ void Flush(); //!< Get rid of buffered input.
+
+ // Protected utility functions.
+protected:
+ static void StockStateMap();
+ unsigned short Service(const std::string& rService);
+ std::string AddressToHostString(in_addr peer);
+ void OpenSocket();
+};
+
+#endif
+
Property changes on: trunk/llnlReadout/vmusb/CSocket.h
___________________________________________________________________
Added: svn:executable
+ *
Added: trunk/llnlReadout/vmusb/CTCPBadSocketState.cpp
===================================================================
--- trunk/llnlReadout/vmusb/CTCPBadSocketState.cpp (rev 0)
+++ trunk/llnlReadout/vmusb/CTCPBadSocketState.cpp 2010-11-24 11:57:08 UTC (rev 2408)
@@ -0,0 +1,397 @@
+/*
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of this License,
+ you may choose any version ever published by the Free Software Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author to
+ask for permission. For software which is copyrighted by the Free Software
+Foundation, write to the Free Software Foundation; we sometimes make
+exceptions for this. Our decision will be guided by the two goals of
+preserving the free status of all derivatives of our free software and of
+promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
+THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
+THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
+YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
+LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
+THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+ '
+*/
+
+
+static const char* Copyright= Copyright= "(C) Copyright Michigan State University 2002, All rights reserved";// Author:
+// Ron Fox
+// NSCL
+// Michigan State University
+// East Lansing, MI 48824-1321
+// mailto:fo...@ns...
+//
+// Copyright
+// NSCL All rights reserved.
+//
+// See CTCPBadSocketState.h for a description of this class.
+#include <config.h>
+#include <CTCPBadSocketState.h>
+
+#ifdef HAVE_STD_NAMESPACE
+using namespace std;
+#endif
+
+// Constructors and related methods.
+
+/*!
+ "Normal Constructor" This constructor is normally used prior to
+ throwing a CTCPBadSocketState object as an exception.
+
+ \param badState - the state of the CSocket object which threw the
+ exception which was objectionable.
+ \param okStates - A vector of states which would have been ok
+ for the socket to have been in at the time it threw.
+ \param pDoing - A textual description of what the CSocket object
+ was asked to do when it detected the invalid state.
+ */
+
+CTCPBadSocketState::CTCPBadSocketState(CSocket::State badState,...
[truncated message content] |