ChannelClient.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBIPC_CHANNELCLIENT_H
#define __LIBIPC_CHANNELCLIENT_H
 
#include <Singleton.h>
#include <Callback.h>
#include <Index.h>
#include "ChannelRegistry.h"
#include "Channel.h"
#include "ChannelMessage.h"
 
class ChannelClient : public StrictSingleton<ChannelClient>
{
  private:
 
    static const Size MaximumRequests = 32u;
 
    static const Size MaxConnectRetries = 16u;
 
    typedef struct Request
    {
        bool active;
        ProcessID pid;
        ChannelMessage *message;
        CallbackFunction *callback;
 
        const bool operator == (const struct Request & req) const
        {
            return req.message == message && req.callback == callback;
        }
 
        const bool operator != (const struct Request & req) const
        {
            return req.message != message || req.callback != callback;
        }
    }
    Request;
 
  public:
 
    enum Result
    {
        Success,
        InvalidArgument,
        InvalidSize,
        IOError,
        OutOfMemory,
        NotFound
    };
 
  public:
 
    ChannelClient();
 
    virtual ~ChannelClient();
 
    ChannelRegistry & getRegistry();
 
    virtual Result initialize();
 
    virtual Result connect(const ProcessID pid, const Size msgSize);
 
    virtual Result receiveAny(void *buffer, const Size msgSize, ProcessID *pid);
 
    virtual Result sendRequest(const ProcessID pid,
                               void *buffer,
                               const Size msgSize,
                               CallbackFunction *callback);
 
    virtual Result processResponse(const ProcessID pid,
                                   ChannelMessage *msg);
 
    virtual Result syncReceiveFrom(void *buffer, const Size msgSize, const ProcessID pid);
 
    virtual Result syncSendTo(const void *buffer, const Size msgSize, const ProcessID pid);
 
    virtual Result syncSendReceive(void *buffer, const Size msgSize, const ProcessID pid);
 
  private:
 
    Channel * findConsumer(const ProcessID pid, const Size msgSize);
 
    Channel * findProducer(const ProcessID pid, const Size msgSize);
 
  private:
 
    ChannelRegistry m_registry;
 
    Index<Request, MaximumRequests> m_requests;
 
    const ProcessID m_pid;
};
 
#endif /* __LIBIPC_CHANNELCLIENT_H */