uclient.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2004, 2006-2011, Gostai S.A.S.
 *
 * This software is provided "as is" without warranty of any kind,
 * either expressed or implied, including but not limited to the
 * implied warranties of fitness for a particular purpose.
 *
 * See the LICENSE file for more information.
 */


#ifndef URBI_UCLIENT_HH
# define URBI_UCLIENT_HH

# include <libport/asio.hh>
# include <libport/pthread.h>
# include <libport/semaphore.hh>
# include <libport/utime.hh>

# include <urbi/uabstractclient.hh>

namespace urbi
{

  class URBI_SDK_API UClient
    : public UAbstractClient
    , public libport::Socket
  {
  public:
    struct URBI_SDK_API options
    {
      options(bool server = false);
# define UCLIENT_OPTION(Type, Name)             \
    public:                                     \
      options& Name(Type b);                    \
      Type Name() const;                        \
    private:                                    \
      Type Name ## _;

      UCLIENT_OPTION(bool, server);
      UCLIENT_OPTION(bool, start);
      UCLIENT_OPTION(bool, asynchronous);
    };

# define UCLIENT_OPTION_IMPL(Class, Type, Name) \
  Class::options&                               \
  Class::options::Name(Type v)                  \
  {                                             \
    Name ## _ = v;                              \
    return *this;                               \
  }                                             \
                                                \
  Type                                          \
  Class::options::Name() const                  \
  {                                             \
    return Name ## _;                           \
  }

    UClient(const std::string& host = default_host(),
            unsigned port = URBI_PORT,
            size_t buflen = URBI_BUFLEN,
            // FIXME: See http://llvm.org/bugs/show_bug.cgi?id=8692,
            // revert this in the future.
            // FIXME: ndmefyl: changed from options::options(false) -
            // wtf a direct call to a ctor - which doesn't work - at
            // least with 4.5.1 - to option(false). If this is related
            // to the LLVM bug, please check you're not breaking gcc
            // compilation while fixing.
            const UClient::options& opt = options(false));

    virtual ~UClient();

    virtual void waitForKernelVersion() const;

    error_type start();
  protected:
    virtual error_type onClose();

  public:
    int closeUClient ();

    ATTRIBUTE_PRINTF(2, 3)
    virtual void printf(const char* format, ...);

    virtual unsigned int getCurrentTime() const;

    virtual void setKeepAliveCheck(unsigned pingInterval,
                                   unsigned pongTimeout);

    using UAbstractClient::send;

    void setSynchronousSend(bool enable);
  protected:
    virtual int effectiveSend(const void* buffer, size_t size);

    libport::Socket* mySocketFactory();

    virtual void onConnect();

    virtual void onError(boost::system::error_code erc);

    virtual size_t onRead(const void*, size_t length);

  protected:
    libport::utime_t ping_interval_;

    libport::utime_t pong_timeout_;

    typedef boost::shared_ptr<UClient*> link_type;
    link_type link_;

    void pongTimeout(link_type l);

    void sendPing(link_type l);

    libport::utime_t ping_sent_;

    libport::AsyncCallHandler pong_timeout_handler_;
    libport::AsyncCallHandler send_ping_handler_;

    libport::Semaphore ping_sem_;

  private:
    error_type connect_();
    error_type listen_();
    void resetAsyncCalls_();
    bool asynchronous_;
    bool synchronous_send_;
  };

} // namespace urbi
#endif