merged changeset r4281:4292 on trondeau/ethernet into trunk
[debian/gnuradio] / gnuradio-core / src / lib / io / gr_udp_sink.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef INCLUDED_GR_UDP_SINK_H
24 #define INCLUDED_GR_UDP_SINK_H
25
26 #include <gr_sync_block.h>
27 #include <omnithread.h>
28 #include <sys/socket.h>
29 #include <arpa/inet.h>
30
31 class gr_udp_sink;
32 typedef boost::shared_ptr<gr_udp_sink> gr_udp_sink_sptr;
33
34 /*!
35  * \brief Write stream to an Udp port (over UDP).
36  * \ingroup sink
37  */
38
39 gr_udp_sink_sptr
40 gr_make_udp_sink (size_t itemsize, 
41                   const char *ipaddrl, unsigned short portl,
42                   const char *ipaddrr, unsigned short portr,
43                   unsigned int mtu=540);
44
45 class gr_udp_sink : public gr_sync_block
46 {
47   friend gr_udp_sink_sptr gr_make_udp_sink (size_t itemsize, 
48                                             const char *ipaddrl, unsigned short portl,
49                                             const char *ipaddrr, unsigned short portr,
50                                             unsigned int mtu);
51  private:
52   size_t        d_itemsize;
53   bool          d_updated;
54   omni_mutex    d_mutex;
55
56   unsigned int   d_mtu;             // maximum transmission unit (packet length)
57   int            d_socket;          // handle to socket
58   int            d_socket_rcv;      // handle to socket retuned in the accept call
59   struct in_addr d_ipaddr_local;    // store the local IP address to use
60   struct in_addr d_ipaddr_remote;   // store the remote IP address that connected to us
61   unsigned short d_port_local;      // the port number to open for connections to this service
62   unsigned short d_port_remote;     // port number of the remove system
63   sockaddr_in    d_sockaddr_local;  // store the local sockaddr data (formatted IP address and port number)
64   sockaddr_in    d_sockaddr_remote; // store the remote sockaddr data (formatted IP address and port number)
65
66  protected:
67   gr_udp_sink (size_t itemsize, 
68                     const char *ipaddrl, unsigned short portl,
69                     const char *ipaddrr, unsigned short portr,
70                     unsigned int mtu);
71
72  public:
73   ~gr_udp_sink ();
74
75   /*!
76    * \brief open a socket specified by the port and ip address info
77    *
78    * Opens a socket, binds to the address, and makes connectionless association
79    * over UDP. If any of these fail, the fuction retuns the error and exits.
80    */
81   bool open();
82
83   /*!
84    * \brief Close current socket.
85    *
86    * Shuts down read/write on the socket
87    */
88   void close();
89
90   /*! \brief set the MTU of the socket */
91   void set_mtu(unsigned int mtu) { d_mtu = mtu; }
92
93   /*! \brief return the MTU of the socket */
94   unsigned int mtu() { return d_mtu; }
95
96   // should we export anything else?
97
98   int work (int noutput_items,
99             gr_vector_const_void_star &input_items,
100             gr_vector_void_star &output_items);
101 };
102
103 #endif /* INCLUDED_GR_UDP_SINK_H */