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