common/remoteconnection.h

Go to the documentation of this file.

/* Copyright (C) 2006,2007,2008,2010,2011 Olly Betts
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef XAPIAN_INCLUDED_REMOTECONNECTION_H
#define XAPIAN_INCLUDED_REMOTECONNECTION_H

#include <string>

#include "remoteprotocol.h"
#include "safeunistd.h"

#ifdef __WIN32__
# include "safewinsock2.h"

# include <xapian/error.h>

struct WinsockInitializer {
    WinsockInitializer() {
        WSADATA wsadata;
        int wsaerror = WSAStartup(MAKEWORD(2,2), &wsadata);
        // FIXME - should we check the returned information in wsadata to check
        // that we have a version of winsock which is recent enough for us?

        if (wsaerror != 0) {
            throw Xapian::NetworkError("Failed to initialize winsock", wsaerror);
        }
    }

    ~WinsockInitializer() {
        WSACleanup();
    }
};

inline int socket_errno() {
    return -(int)WSAGetLastError();
}

// Define some of the UNIX socket error constants to be negated versions of the
// winsock ones.
# define EADDRINUSE (-(WSAEADDRINUSE))
# define ETIMEDOUT (-(WSAETIMEDOUT))
# define EINPROGRESS (-(WSAEINPROGRESS))

#else
// Use a macro so we don't need to pull safeerrno.h in here.
# define socket_errno() errno
#endif

class RemoteConnection {
    void operator=(const RemoteConnection &);

    RemoteConnection(const RemoteConnection &);

    int fdin;

    int fdout;

    std::string buffer;

    off_t chunked_data_left;

    void read_at_least(size_t min_len, double end_time);

#ifdef __WIN32__

    WSAOVERLAPPED overlapped;

    DWORD calc_read_wait_msecs(double end_time);
#endif

  protected:
    std::string context;

  public:
    RemoteConnection(int fdin_, int fdout_,
                     const std::string & context_ = std::string());

    ~RemoteConnection();

    bool ready_to_read() const;

    char sniff_next_message_type(double end_time);

    char get_message(std::string &result, double end_time);

    char get_message_chunked(double end_time);

    bool get_message_chunk(std::string &result, size_t at_least,
                           double end_time);

    char receive_file(const std::string &file, double end_time);

    void send_message(char type, const std::string & s, double end_time);

    void send_file(char type, int fd, double end_time);

    void do_close(bool wait);
};

#endif // XAPIAN_INCLUDED_REMOTECONNECTION_H

---