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

Last change on this file since 363 was 363, checked in by Sanahuja Guillaume, 2 years ago

allow mutliple connection on udp (only nrt for the moment)

File size: 2.8 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 */
69 void SendMessage(std::string message);
70
71 /*!
72 * \brief Send a message
73 *
74 * \param message message
75 * \param message_len message length
76 * \param dst_id id of the dst if multiple connection (quick and dirty hack for sido, only works on NRT)
77 */
78 void SendMessage(const char *message, size_t message_len,int dst_id=0);
79
80 /*!
81 * \brief Receive a message
82 *
83 * Receive a message and wait up to timeout. \n
84 * If src and src_len are specified, the source of the message will be
85 * copied in the src buffer. Source is the Flair name of sender\n
86 * Note that in case of a broadcast socket, own messages are filtered and
87 * are not received.
88 *
89 * \param buf buffer to put the message
90 * \param buf_len buffer length
91 * \param timeout timeout
92 * \param src buffer to put source name
93 * \param src_len buffer length
94 * \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)
95 *
96 * \return size of the received message
97 */
98 ssize_t RecvMessage(char *buf, size_t buf_len, Time timeout, char *src = NULL,
99 size_t *src_len = NULL,int *src_id=NULL);
100
101 void NetworkToHost(char *data, size_t dataSize);
102 void HostToNetwork(char *data, size_t dataSize);
103
104private:
105 class UdpSocket_impl *pimpl_;
106};
107
108} // end namespace core
109} // end namespace flair
110
111#endif // UDPSOCKET_H
Note: See TracBrowser for help on using the repository browser.