Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages | Examples

ArTcpConnection.h

00001 /*
00002 MobileRobots Advanced Robotics Interface for Applications (ARIA)
00003 Copyright (C) 2004, 2005 ActivMedia Robotics LLC
00004 Copyright (C) 2006, 2007 MobileRobots Inc.
00005 
00006      This program is free software; you can redistribute it and/or modify
00007      it under the terms of the GNU General Public License as published by
00008      the Free Software Foundation; either version 2 of the License, or
00009      (at your option) any later version.
00010 
00011      This program is distributed in the hope that it will be useful,
00012      but WITHOUT ANY WARRANTY; without even the implied warranty of
00013      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014      GNU General Public License for more details.
00015 
00016      You should have received a copy of the GNU General Public License
00017      along with this program; if not, write to the Free Software
00018      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00019 
00020 If you wish to redistribute ARIA under different terms, contact 
00021 MobileRobots for information about a commercial version of ARIA at 
00022 robots@mobilerobots.com or 
00023 MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
00024 */
00025 
00026 #ifndef ARTCPCONNECTION_H
00027 #define ARTCPCONNECTION_H
00028 
00029 #include "ArDeviceConnection.h"
00030 #include <string>
00031 
00032 #include "ariaTypedefs.h"
00033 #include "ArSocket.h"
00034 
00036 class ArTcpConnection: public ArDeviceConnection
00037 {
00038  public:
00040   AREXPORT ArTcpConnection();
00042   AREXPORT virtual ~ArTcpConnection();
00043 
00045   AREXPORT int open(const char * host = NULL, int port = 8101);
00046 
00047   AREXPORT void setPort(const char *host = NULL, int port = 8101);
00048   AREXPORT virtual bool openSimple(void);  
00049   AREXPORT virtual int getStatus(void);
00050   AREXPORT virtual bool close(void);
00051   AREXPORT virtual int read(const char *data, unsigned int size, 
00052                 unsigned int msWait = 0);
00053   AREXPORT virtual int write(const char *data, unsigned int size);
00054   AREXPORT virtual const char * getOpenMessage(int messageNumber);
00055   AREXPORT virtual ArTime getTimeRead(int index);
00056   AREXPORT virtual bool isTimeStamping(void);
00057 
00059   AREXPORT std::string getHost(void);
00061   AREXPORT int getPort(void);
00062 
00064   AREXPORT int internalOpen(void);
00065 
00067   AREXPORT void setSocket(ArSocket *socket);
00069   AREXPORT ArSocket *getSocket(void);
00072   AREXPORT void setStatus(int status);
00073 
00074   enum Open { 
00075       OPEN_NET_FAIL = 1, 
00076       OPEN_BAD_HOST, 
00077       OPEN_NO_ROUTE, 
00078       OPEN_CON_REFUSED 
00079   };
00080 
00081 
00082 
00083 protected:
00084   void buildStrMap(void);
00085   
00086   ArStrMap myStrMap;
00087   bool myOwnSocket;
00088   ArSocket *mySocket;
00089   int myStatus;
00090   
00091   std::string myHostName;
00092   int myPortNum;
00093 };
00094 
00095 #endif //ARTCPCONNECTION_H

Generated on Tue Feb 20 10:51:41 2007 for Aria by  doxygen 1.4.0