source: flair-src/trunk/lib/FlairCore/src/UdpSocket.h @ 447

Last change on this file since 447 was 387, checked in by Sanahuja Guillaume, 12 months ago

resolve bug with udp broadcast

File size: 2.9 KB
Line 
1// %flair:license{
2// This file is part of the Flair framework distributed under the
3// CECILL-C License, Version 1.0.
4// %flair:license}
5/*!
6 * \file Socket.h
7 * \brief Class defining a UDP socket
8 * \author Guillaume Sanahuja, Copyright Heudiasyc UMR UTC/CNRS 7253
9 * \date 2013/11/17
10 * \version 4.0
11 */
12
13#ifndef UDPSOCKET_H
14#define UDPSOCKET_H
15
16#include <Object.h>
17
18class UdpSocket_impl;
19
20namespace flair {
21namespace core {
22
23/*! \class UdpSocket
24*
25* \brief Class encapsulating a UDP socket. It assumes packets are coming from
26*only one distant host on a given port.
27*
28*/
29class UdpSocket : public Object {
30public:
31  /*!
32  * \brief Constructor
33  *
34  * Construct the client side of the socket
35  *
36  * \param parent parent
37  * \param name name
38  * \param address server address (ex 192.168.1.1:9000)
39  * \param broadcast true if address is a broadcast address
40  */
41  UdpSocket(const Object *parent, std::string name, std::string address,
42         bool broadcast = false);
43
44  /*!
45  * \brief Constructor
46  *
47  * Construct the server side of the socket
48  *
49  * \param parent parent
50  * \param name name
51  * \param port listening port
52  */
53  UdpSocket(const Object *parent, std::string name, uint16_t port);
54
55  /*!
56  * \brief Destructor
57  *
58  */
59  ~UdpSocket();
60
61  /*!
62  * \brief Send a message
63  *
64  * In case of a broadcast Socket, Parent()->ObjectName() is used as source of
65  *the message, this name should be unique.
66  *
67  * \param message message
68  * \param dst_id id of the dst if multiple connection (quick and dirty hack for sido, only works on NRT)
69  */
70  void SendMessage(std::string message,int dst_id=0);
71
72  /*!
73  * \brief Send a message
74  *
75  * \param message message
76  * \param message_len message length
77  * \param dst_id id of the dst if multiple connection (quick and dirty hack for sido, only works on NRT)
78  */
79  void SendMessage(const char *message, size_t message_len,int dst_id=0);
80
81  /*!
82  * \brief Receive a message
83  *
84  * Receive a message and wait up to timeout. \n
85  * If src and src_len are specified, the source of the message will be
86  * copied in the src buffer. Source is the Flair name of sender\n
87  * Note that in case of a broadcast socket, own messages are filtered and
88  * are not received.
89  *
90  * \param buf buffer to put the message
91  * \param buf_len buffer length
92  * \param timeout timeout
93  * \param src buffer to put source name
94  * \param src_len buffer length
95  * \param src_id id of the src, to be used for sending if multiple connection (quick and dirty hack for sido, only works on NRT)
96  *
97  * \return size of the received message
98  */
99  ssize_t RecvMessage(char *buf, size_t buf_len, Time timeout, char *src = NULL,
100                      size_t *src_len = NULL,int *src_id=NULL);
101
102  void NetworkToHost(char *data, size_t dataSize);
103  void HostToNetwork(char *data, size_t dataSize);
104
105private:
106  class UdpSocket_impl *pimpl_;
107};
108
109} // end namespace core
110} // end namespace flair
111
112#endif // UDPSOCKET_H
Note: See TracBrowser for help on using the repository browser.