ucontext.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2009, 2010, 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_UCONTEXT_HH
# define URBI_UCONTEXT_HH

# include <libport/fwd.hh>
# include <libport/utime.hh>

# include <urbi/uvalue.hh>

namespace urbi
{
  enum UObjectMode
  {
    MODE_PLUGIN = 1,
    MODE_REMOTE
  };

  class UAutoValue: public UValue
  {
  public:
    UAutoValue();
    template<typename T>
    UAutoValue(T v);
    UAutoValue(const UValue& v);
  };

  class URBI_SDK_API UContext
  {
  public:
    UContext(impl::UContextImpl* ctx=0);
    UObjectHub* getUObjectHub(const std::string& n);
    UObject* getUObject(const std::string& n);
    void uobject_unarmorAndSend(const char* str);

    void send(const char* str);
    void send(const std::string&s);
    void send(const void* buf, size_t size);
    void call(const std::string& object,
              const std::string& method,
              UAutoValue v1 = UAutoValue(),
              UAutoValue v2 = UAutoValue(),
              UAutoValue v3 = UAutoValue(),
              UAutoValue v4 = UAutoValue(),
              UAutoValue v5 = UAutoValue(),
              UAutoValue v6 = UAutoValue());

    boost::asio::io_service& getIoService();

    UObjectMode getRunningMode() const;

    bool isPluginMode() const;
    bool isRemoteMode() const;

    void yield() const;

    void yield_until(libport::utime_t deadline) const;

    void yield_for(libport::utime_t delay) const;

    void yield_until_things_changed() const;

    void side_effect_free_set(bool s);

    bool side_effect_free_get() const;

    std::pair<int, int> kernelVersion();
    impl::UContextImpl* ctx_;
  };

  URBI_SDK_API impl::UContextImpl* getCurrentContext();
  URBI_SDK_API void setCurrentContext(impl::UContextImpl*);

  ATTRIBUTE_DEPRECATED
  ATTRIBUTE_PRINTF(1, 2)
  URBI_SDK_API void echo(const char* format, ...);
}

# include "urbi/ucontext.hxx"
#endif