Visual Servoing Platform  version 3.3.0 under development (2020-02-17)
vpUDPClient.h
1 /****************************************************************************
2  *
3  * ViSP, open source Visual Servoing Platform software.
4  * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * See the file LICENSE.txt at the root directory of this source
11  * distribution for additional information about the GNU GPL.
12  *
13  * For using ViSP with software that can not be combined with the GNU
14  * GPL, please contact Inria about acquiring a ViSP Professional
15  * Edition License.
16  *
17  * See http://visp.inria.fr for more information.
18  *
19  * This software was developed at:
20  * Inria Rennes - Bretagne Atlantique
21  * Campus Universitaire de Beaulieu
22  * 35042 Rennes Cedex
23  * France
24  *
25  * If you have questions regarding the use of this file, please contact
26  * Inria at visp@inria.fr
27  *
28  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30  *
31  * Description:
32  * UDP Client
33  *
34  *****************************************************************************/
35 
36 #ifndef _vpUDPClient_h_
37 #define _vpUDPClient_h_
38 
39 #include <visp3/core/vpConfig.h>
40 
41 // inet_ntop() not supported on win XP
42 #ifdef VISP_HAVE_FUNC_INET_NTOP
43 
44 #if !defined(_WIN32) && (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__))) // UNIX
45 # include <netinet/in.h>
46 # include <sys/socket.h>
47 # include <sys/types.h>
48 #else
49 # include <winsock2.h>
50 #endif
51 
52 #include <visp3/core/vpException.h>
53 
54 #define VP_MAX_UDP_PAYLOAD 508
55 
168 class VISP_EXPORT vpUDPClient
169 {
170 public:
171  vpUDPClient();
172  vpUDPClient(const std::string &hostname, int port);
173  virtual ~vpUDPClient();
174 
177  void init(const std::string &hostname, int port);
178 
179  int receive(std::string &msg, int timeoutMs = 0);
180  int receive(void *msg, size_t len, int timeoutMs = 0);
181  int send(const std::string &msg);
182  int send(const void *msg, size_t len);
184 
185 protected:
186  bool m_is_init;
187 
188 private:
189  char m_buf[VP_MAX_UDP_PAYLOAD];
190  struct sockaddr_in m_serverAddress;
191  int m_serverLength;
192 #if !defined(_WIN32) && (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__))) // UNIX
193  int m_socketFileDescriptor;
194 #else
195  SOCKET m_socketFileDescriptor;
196  WSADATA m_wsa;
197 #endif
198 
199  void close();
200 };
201 
202 #endif
203 #endif
bool m_is_init
Definition: vpUDPClient.h:186
This class implements a basic (IPv4) User Datagram Protocol (UDP) client.
Definition: vpUDPClient.h:168