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

    This file is part of 0MQ.

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

    0MQ 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
14
    GNU Lesser General Public License for more details.
malosek's avatar
malosek committed
15

16
    You should have received a copy of the GNU Lesser General Public License
malosek's avatar
malosek committed
17 18 19 20 21 22 23 24
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __PGM_SOCKET_HPP_INCLUDED__
#define __PGM_SOCKET_HPP_INCLUDED__

#include "platform.hpp"

malosek's avatar
malosek committed
25
#if defined ZMQ_HAVE_OPENPGM
malosek's avatar
malosek committed
26

27 28
#ifdef ZMQ_HAVE_WINDOWS
#include "windows.hpp"
29
#define __PGM_WININT_H__
malosek's avatar
malosek committed
30 31
#endif

32 33
#include <pgm/pgm.h>

34 35 36 37
#ifdef ZMQ_HAVE_OSX
#include <pgm/in.h>
#endif

38
#include "fd.hpp"
malosek's avatar
malosek committed
39 40 41 42 43 44 45 46 47
#include "options.hpp"

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

    public:
48

malosek's avatar
malosek committed
49 50 51 52 53 54 55
        //  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).
56
        int init (bool udp_encapsulation_, const char *network_);
57 58 59

        //  Resolve PGM socket address.
        static int init_address(const char *network_, struct pgm_addrinfo_t **addr, uint16_t *port_number);
malosek's avatar
malosek committed
60 61
        
        //   Get receiver fds and store them into user allocated memory.
62
        void get_receiver_fds (fd_t *receive_fd_, fd_t *waiting_pipe_fd_);
malosek's avatar
malosek committed
63 64 65

        //   Get sender and receiver fds and store it to user allocated 
        //   memory. Receive fd is used to process NAKs from peers.
66 67
        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
68 69 70 71

        //  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
72 73
        //  Returns max tsdu size without fragmentation.
        size_t get_max_tsdu_size ();
malosek's avatar
malosek committed
74 75

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

78 79 80
        long get_rx_timeout ();
        long get_tx_timeout ();

malosek's avatar
malosek committed
81 82
        //  POLLIN on sender side should mean NAK or SPMR receiving. 
        //  process_upstream function is used to handle such a situation.
83
        void process_upstream ();
malosek's avatar
malosek committed
84

85
    private:
86 87 88

        //  Compute size of the buffer based on rate and recovery interval.
        int compute_sqns (int tpdu_);
malosek's avatar
malosek committed
89
    
90
        //  OpenPGM transport.
Steven McCoy's avatar
Steven McCoy committed
91
        pgm_sock_t* sock;
malosek's avatar
malosek committed
92

93 94
        int last_rx_status, last_tx_status;

malosek's avatar
malosek committed
95 96 97
        //  Associated socket options.
        options_t options;
       
malosek's avatar
malosek committed
98 99 100
        //  true when pgm_socket should create receiving side.
        bool receiver;

Martin Sustrik's avatar
Martin Sustrik committed
101
        //  Array of pgm_msgv_t structures to store received data
malosek's avatar
malosek committed
102 103 104
        //  from the socket (pgm_transport_recvmsgv).
        pgm_msgv_t *pgm_msgv;

Martin Sustrik's avatar
Martin Sustrik committed
105 106 107
        //  Size of pgm_msgv array.
        size_t pgm_msgv_len;

malosek's avatar
malosek committed
108
        // How many bytes were read from pgm socket.
malosek's avatar
malosek committed
109
        size_t nbytes_rec;
malosek's avatar
malosek committed
110 111

        //  How many bytes were processed from last pgm socket read.
malosek's avatar
malosek committed
112
        size_t nbytes_processed;
malosek's avatar
malosek committed
113 114
        
        //  How many messages from pgm_msgv were already sent up.
malosek's avatar
malosek committed
115
        size_t pgm_msgv_processed;
malosek's avatar
malosek committed
116 117 118 119 120
    };
}
#endif

#endif
121