pgm_socket.hpp 4.1 KB
Newer Older
malosek's avatar
malosek committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
malosek's avatar
malosek committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
malosek's avatar
malosek committed
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
malosek's avatar
malosek committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    License for more details.
malosek's avatar
malosek committed
25

26
    You should have received a copy of the GNU Lesser General Public License
malosek's avatar
malosek committed
27 28 29 30 31 32
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __PGM_SOCKET_HPP_INCLUDED__
#define __PGM_SOCKET_HPP_INCLUDED__

malosek's avatar
malosek committed
33
#if defined ZMQ_HAVE_OPENPGM
malosek's avatar
malosek committed
34

35
#ifdef ZMQ_HAVE_WINDOWS
36
#define __PGM_WININT_H__
malosek's avatar
malosek committed
37 38
#endif

39 40
#include <pgm/pgm.h>

41
#if defined(ZMQ_HAVE_OSX) || defined(ZMQ_HAVE_NETBSD)
42 43 44
#include <pgm/in.h>
#endif

45
#include "fd.hpp"
malosek's avatar
malosek committed
46 47 48 49 50 51 52 53 54
#include "options.hpp"

namespace zmq
{
    //  Encapsulates PGM socket.
    class pgm_socket_t
    {

    public:
55

malosek's avatar
malosek committed
56 57 58 59 60 61 62
        //  If receiver_ is true PGM transport is not generating SPM packets.
        pgm_socket_t (bool receiver_, const options_t &options_);

        //  Closes the transport.
        ~pgm_socket_t ();

        //  Initialize PGM network structures (GSI, GSRs).
63
        int init (bool udp_encapsulation_, const char *network_);
64 65 66

        //  Resolve PGM socket address.
        static int init_address(const char *network_, struct pgm_addrinfo_t **addr, uint16_t *port_number);
67

malosek's avatar
malosek committed
68
        //   Get receiver fds and store them into user allocated memory.
69
        void get_receiver_fds (fd_t *receive_fd_, fd_t *waiting_pipe_fd_);
malosek's avatar
malosek committed
70

71
        //   Get sender and receiver fds and store it to user allocated
malosek's avatar
malosek committed
72
        //   memory. Receive fd is used to process NAKs from peers.
73 74
        void get_sender_fds (fd_t *send_fd_, fd_t *receive_fd_,
            fd_t *rdata_notify_fd_, fd_t *pending_notify_fd_);
malosek's avatar
malosek committed
75 76 77 78

        //  Send data as one APDU, transmit window owned memory.
        size_t send (unsigned char *data_, size_t data_len_);

Martin Sustrik's avatar
Martin Sustrik committed
79 80
        //  Returns max tsdu size without fragmentation.
        size_t get_max_tsdu_size ();
malosek's avatar
malosek committed
81 82

        //  Receive data from pgm socket.
malosek's avatar
malosek committed
83
        ssize_t receive (void **data_, const pgm_tsi_t **tsi_);
malosek's avatar
malosek committed
84

85 86 87
        long get_rx_timeout ();
        long get_tx_timeout ();

88
        //  POLLIN on sender side should mean NAK or SPMR receiving.
malosek's avatar
malosek committed
89
        //  process_upstream function is used to handle such a situation.
90
        void process_upstream ();
malosek's avatar
malosek committed
91

92
    private:
93 94 95

        //  Compute size of the buffer based on rate and recovery interval.
        int compute_sqns (int tpdu_);
96

97
        //  OpenPGM transport.
Steven McCoy's avatar
Steven McCoy committed
98
        pgm_sock_t* sock;
malosek's avatar
malosek committed
99

100 101
        int last_rx_status, last_tx_status;

malosek's avatar
malosek committed
102 103
        //  Associated socket options.
        options_t options;
104

malosek's avatar
malosek committed
105 106 107
        //  true when pgm_socket should create receiving side.
        bool receiver;

Martin Sustrik's avatar
Martin Sustrik committed
108
        //  Array of pgm_msgv_t structures to store received data
malosek's avatar
malosek committed
109 110 111
        //  from the socket (pgm_transport_recvmsgv).
        pgm_msgv_t *pgm_msgv;

Martin Sustrik's avatar
Martin Sustrik committed
112 113 114
        //  Size of pgm_msgv array.
        size_t pgm_msgv_len;

malosek's avatar
malosek committed
115
        // How many bytes were read from pgm socket.
malosek's avatar
malosek committed
116
        size_t nbytes_rec;
malosek's avatar
malosek committed
117 118

        //  How many bytes were processed from last pgm socket read.
malosek's avatar
malosek committed
119
        size_t nbytes_processed;
120

malosek's avatar
malosek committed
121
        //  How many messages from pgm_msgv were already sent up.
malosek's avatar
malosek committed
122
        size_t pgm_msgv_processed;
malosek's avatar
malosek committed
123 124 125 126 127
    };
}
#endif

#endif
128