message_port.h

// message_port.h

/*    Copyright 2009 10gen Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#pragma once

#include "mongo/config.h"

#include <boost/shared_ptr.hpp>
#include <boost/utility.hpp>
#include <vector>

#include "mongo/util/net/message.h"
#include "mongo/util/net/sock.h"

namespace mongo {

class MessagingPort;
class PiggyBackData;

class AbstractMessagingPort : boost::noncopyable {
public:
    AbstractMessagingPort() : tag(0), _connectionId(0) {}
    virtual ~AbstractMessagingPort() {}
    virtual void reply(
        Message& received,
        Message& response,
        // like the reply below, but doesn't rely on received.data still being available
        MSGID responseTo) = 0;
    virtual void reply(Message& received, Message& response) = 0;

    virtual HostAndPort remote() const = 0;
    virtual unsigned remotePort() const = 0;
    virtual SockAddr remoteAddr() const = 0;
    virtual SockAddr localAddr() const = 0;

    void setX509SubjectName(const std::string& x509SubjectName) {
        _x509SubjectName = x509SubjectName;
    }

    std::string getX509SubjectName() {
        return _x509SubjectName;
    }

    long long connectionId() const {
        return _connectionId;
    }
    void setConnectionId(long long connectionId);

public:
    // TODO make this private with some helpers

    /* ports can be tagged with various classes.  see closeAllSockets(tag). defaults to 0. */
    unsigned tag;

private:
    long long _connectionId;
    std::string _x509SubjectName;
};

class MessagingPort : public AbstractMessagingPort {
public:
    MessagingPort(int fd, const SockAddr& remote);

    // in some cases the timeout will actually be 2x this value - eg we do a partial send,
    // then the timeout fires, then we try to send again, then the timeout fires again with
    // no data sent, then we detect that the other side is down
    MessagingPort(double so_timeout = 0, logger::LogSeverity logLevel = logger::LogSeverity::Log());

    MessagingPort(boost::shared_ptr<Socket> socket);

    virtual ~MessagingPort();

    void setSocketTimeout(double timeout);

    void shutdown();

    /* it's assumed if you reuse a message object, that it doesn't cross MessagingPort's.
       also, the Message data will go out of scope on the subsequent recv call.
    */
    bool recv(Message& m);
    void reply(Message& received, Message& response, MSGID responseTo);
    void reply(Message& received, Message& response);
    bool call(Message& toSend, Message& response);

    void say(Message& toSend, int responseTo = 0);

    bool recv(const Message& sent, Message& response);

    void piggyBack(Message& toSend, int responseTo = 0);

    unsigned remotePort() const {
        return psock->remotePort();
    }
    virtual HostAndPort remote() const;
    virtual SockAddr remoteAddr() const;
    virtual SockAddr localAddr() const;

    boost::shared_ptr<Socket> psock;

    void send(const char* data, int len, const char* context) {
        psock->send(data, len, context);
    }
    void send(const std::vector<std::pair<char*, int> >& data, const char* context) {
        psock->send(data, context);
    }
    bool connect(SockAddr& farEnd) {
        return psock->connect(farEnd);
    }
#ifdef MONGO_SSL

    bool secure(SSLManagerInterface* ssl, const std::string& remoteHost) {
        return psock->secure(ssl, remoteHost);
    }
#endif

    bool isStillConnected() {
        return psock->isStillConnected();
    }

    uint64_t getSockCreationMicroSec() const {
        return psock->getSockCreationMicroSec();
    }

private:
    PiggyBackData* piggyBackData;

    // this is the parsed version of remote
    // mutable because its initialized only on call to remote()
    mutable HostAndPort _remoteParsed;

public:
    static void closeAllSockets(unsigned tagMask = 0xffffffff);

    friend class PiggyBackData;
};


}  // namespace mongo