Aria  2.8.0
netServerExample.cpp

Shows how to use ArNetServer, a simple text command receiver

/*
Adept MobileRobots Robotics Interface for Applications (ARIA)
Copyright (C) 2004, 2005 ActivMedia Robotics LLC
Copyright (C) 2006, 2007, 2008, 2009, 2010 MobileRobots Inc.
Copyright (C) 2011, 2012, 2013 Adept Technology
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
If you wish to redistribute ARIA under different terms, contact
Adept MobileRobots for information about a commercial version of ARIA at
robots@mobilerobots.com or
Adept MobileRobots, 10 Columbia Drive, Amherst, NH 03031; +1-603-881-7960
*/
#include "Aria.h"
// To use the net server, start this program, then use the 'telnet' program to connect to localhost
// on TCP port 7171 by running this command:
// telnet localhost 7171
// When connected and prompted for a password, type in:
// password
// and press enter. Then you can enter a command. Use the 'help' command to print available commands.
// For this program, try "test" and "test2" with and without additional arguments.
// ArNetServer is a simple way to provide a quick remote control interface for a robot control
// program running on the robot's onboard computer over wireless networking, if you don't want to
// use the ArNetworking library and MobileEyes. (You can provide both options in a program however,
// ArNetworking and ArNetServer use different TCP ports and will both run fine in the same program.)
// This function just prints out what the client entered and then sends some
// data back. You could modify it to, for example, control the robot with
// different commands.
void test(char **argv, int argc, ArSocket *socket)
{
int i;
printf("Client said: ");
for (i = 0; i < argc; ++i)
printf("\t%s\n", argv[i]);
printf("\n");
socket->writeString("Thank you, command received.");
}
int main(int argc, char **argv)
{
// Initialize Aria
// we need a server
ArNetServer server;
// a callback for our test function
// start the server up without a robot on port 7171 with a password
// of password and allow multiple clients
if (!server.open(NULL, 7171, "password", true))
{
printf("Could not open server.\n");
return 1;
}
// add our test command
server.addCommand("test", &testCB, "this simply prints out the command given on the server");
server.addCommand("test2", &testCB, "this simply prints out the command given on the server");
//server.setLoggingDataSent(true);
//server.setLoggingDataReceived(true);
// run while the server is running
while (server.isOpen() && Aria::getRunning())
{
server.runOnce();
}
server.close();
return 0;
}
ArNetServer::close
void close(void)
Closes the server.
Definition: ArNetServer.cpp:522
ArGlobalFunctor3
Functor for a global function with 3 parameters.
Definition: ArFunctor.h:813
ArNetServer::addCommand
bool addCommand(const char *command, ArFunctor3< char **, int, ArSocket * > *functor, const char *help)
Adds a new command.
Definition: ArNetServer.cpp:164
ArSocket::writeString
int writeString(const char *str,...)
Writes a string to the socket (adding end of line characters)
Definition: ArSocket.cpp:244
Aria::exit
static void exit(int exitCode=0)
Shutdown all Aria processes/threads, call exit callbacks, and exit the program.
Definition: Aria.cpp:367
ArNetServer::isOpen
bool isOpen(void)
Sees if the server is running and open.
Definition: ArNetServer.cpp:261
ArNetServer::open
bool open(ArRobot *robot, unsigned int port, const char *password, bool multipleClients=true, const char *openOnIP=NULL)
Initializes the server.
Definition: ArNetServer.cpp:105
ArNetServer::runOnce
void runOnce(void)
the internal sync task we use for our loop
Definition: ArNetServer.cpp:335
Aria::init
static void init(SigHandleMethod method=SIGHANDLE_THREAD, bool initSockets=true, bool sigHandleExitNotShutdown=true)
Initialize Aria global data struture and perform OS-specific initialization, including adding OS sign...
Definition: Aria.cpp:128
ArUtil::sleep
static void sleep(unsigned int ms)
Sleep for the given number of milliseconds.
Definition: ariaUtil.cpp:151
ArSocket
socket communication wrapper
Definition: ArSocket.h:76
ArNetServer
Class for running a simple net server to send/recv commands via text.
Definition: ArNetServer.h:72
Aria::getRunning
static bool getRunning(void)
Sees if Aria is still running (mostly for the thread in main)
Definition: Aria.cpp:753