Urbi SDK Remote for C++: urbi::UContext Class Reference

Urbi SDK Remote for C++ 2.7.5

Methods available in both UObject and UVar Wrapper around UContextImpl to enable access through inheritance. More...

#include <ucontext.hh>

Inheritance diagram for urbi::UContext:

Inheritance graph

Collaboration diagram for urbi::UContext:

Collaboration graph

List of all members.

Public Member Functions
	UContext (impl::UContextImpl *ctx=0)
UObjectHub *	getUObjectHub (const std::string &n)
UObject *	getUObject (const std::string &n)
void	uobject_unarmorAndSend (const char *str)
	Send Urbi code (ghost connection in plugin mode, default connection in remote mode).
void	send (const char *str)
	Send the string to the connection hosting the UObject.
void	send (const std::string &s)
void	send (const void *buf, size_t size)
	Send buf to the connection hosting the UObject.
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 ()
	The underlying IO Service, from the UContextImpl.
UObjectMode	getRunningMode () const
	The mode in which the code is running.
bool	isPluginMode () const
	Whether running in plugin mode.
bool	isRemoteMode () const
	Whether running in remote mode.
void	yield () const
	Yield execution until next cycle.
void	yield_until (libport::utime_t deadline) const
	Yield execution until deadline is met (see libport::utime()).
void	yield_for (libport::utime_t delay) const
	Yield execution for delay.
void	yield_until_things_changed () const
	Yield execution until something else is scheduled, or until a message is received in remote mode.
void	side_effect_free_set (bool s)
	If s is true, mark the current task as having no side effect.
bool	side_effect_free_get () const
	Get the current side_effect_free state.
std::pair< int, int >	kernelVersion ()
	Get the version of the kernel that will receive send() messages.
Public Attributes
impl::UContextImpl *	ctx_

Detailed Description

Methods available in both UObject and UVar Wrapper around UContextImpl to enable access through inheritance.

Definition at line 41 of file ucontext.hh.

Constructor & Destructor Documentation

urbi::UContext::UContext ( impl::UContextImpl * ctx = 0 ) [inline]

Definition at line 45 of file ucontext.hxx.

Member Function Documentation

void urbi::UContext::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()`
	)		`[inline]`

Definition at line 133 of file ucontext.hxx.

References urbi::impl::UContextImpl::call(), and ctx_.

boost::asio::io_service & urbi::UContext::getIoService ( ) [inline]

The underlying IO Service, from the UContextImpl.

Definition at line 52 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::getIoService().

UObjectMode urbi::UContext::getRunningMode ( ) const [inline]

The mode in which the code is running.

Return the mode in which the code is running.

Definition at line 158 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::getRunningMode().

Referenced by isPluginMode(), and isRemoteMode().

UObject * urbi::UContext::getUObject ( const std::string & n ) [inline]

Definition at line 75 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::getUObject().

UObjectHub * urbi::UContext::getUObjectHub ( const std::string & n ) [inline]

Definition at line 64 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::getUObjectHub().

bool urbi::UContext::isPluginMode ( ) const [inline]

Whether running in plugin mode.

Return true if the code is running in plugin mode.

Definition at line 171 of file ucontext.hxx.

References getRunningMode(), and urbi::MODE_PLUGIN.

bool urbi::UContext::isRemoteMode ( ) const [inline]

Whether running in remote mode.

Return true if the code is running in remote mode.

Definition at line 183 of file ucontext.hxx.

References getRunningMode(), and urbi::MODE_REMOTE.

std::pair< int, int > urbi::UContext::kernelVersion ( ) [inline]

Get the version of the kernel that will receive send() messages.

Definition at line 234 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::kernelVersion().

void urbi::UContext::send ( const char * str ) [inline]

Send the string to the connection hosting the UObject.

Definition at line 102 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::send().

Referenced by urbi::UObject::UJoinGroup().

void urbi::UContext::send ( const std::string & s ) [inline]

Definition at line 114 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::send().

void urbi::UContext::send	(	const void *	buf,
		size_t	size
	)		`[inline]`

Send buf to the connection hosting the UObject.

Definition at line 127 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::send().

bool urbi::UContext::side_effect_free_get ( ) const [inline]

Get the current side_effect_free state.

Definition at line 228 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::side_effect_free_get().

void urbi::UContext::side_effect_free_set ( bool s ) [inline]

If s is true, mark the current task as having no side effect.

This call has no effect in remote mode.

Definition at line 221 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::side_effect_free_set().

void urbi::UContext::uobject_unarmorAndSend ( const char * str ) [inline]

Send Urbi code (ghost connection in plugin mode, default connection in remote mode).

Definition at line 89 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::uobject_unarmorAndSend().

void urbi::UContext::yield ( ) const [inline]

Yield execution until next cycle.

Yield execution until next cycle. Process pending messages in remote mode.

Process pending messages in remote mode.

Definition at line 190 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::yield().

void urbi::UContext::yield_for ( libport::utime_t delay ) const [inline]

Yield execution for delay.

Definition at line 203 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::yield_for().

void urbi::UContext::yield_until ( libport::utime_t deadline ) const [inline]

Yield execution until deadline is met (see libport::utime()).

Definition at line 197 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::yield_until().

void urbi::UContext::yield_until_things_changed ( ) const [inline]

Yield execution until something else is scheduled, or until a message is received in remote mode.

Definition at line 212 of file ucontext.hxx.

References ctx_, and urbi::impl::UContextImpl::yield_until_things_changed().

Member Data Documentation

impl::UContextImpl* urbi::UContext::ctx_

Definition at line 101 of file ucontext.hh.

Referenced by urbi::UCallback0< OBJ, R >::__evalcall(), urbi::UFCallback0< R >::__evalcall(), urbi::UCallback1< OBJ, R, P1 >::__evalcall(), urbi::UFCallback1< R, P1 >::__evalcall(), urbi::UCallback2< OBJ, R, P1, P2 >::__evalcall(), urbi::UFCallback2< R, P1, P2 >::__evalcall(), urbi::UCallback3< OBJ, R, P1, P2, P3 >::__evalcall(), urbi::UFCallback3< R, P1, P2, P3 >::__evalcall(), urbi::UCallback4< OBJ, R, P1, P2, P3, P4 >::__evalcall(), urbi::UFCallback4< R, P1, P2, P3, P4 >::__evalcall(), urbi::UCallback5< OBJ, R, P1, P2, P3, P4, P5 >::__evalcall(), urbi::UFCallback5< R, P1, P2, P3, P4, P5 >::__evalcall(), urbi::UCallback6< OBJ, R, P1, P2, P3, P4, P5, P6 >::__evalcall(), urbi::UFCallback6< R, P1, P2, P3, P4, P5, P6 >::__evalcall(), urbi::UCallback7< OBJ, R, P1, P2, P3, P4, P5, P6, P7 >::__evalcall(), urbi::UFCallback7< R, P1, P2, P3, P4, P5, P6, P7 >::__evalcall(), urbi::UCallback8< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8 >::__evalcall(), urbi::UFCallback8< R, P1, P2, P3, P4, P5, P6, P7, P8 >::__evalcall(), urbi::UCallback9< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9 >::__evalcall(), urbi::UFCallback9< R, P1, P2, P3, P4, P5, P6, P7, P8, P9 >::__evalcall(), urbi::UCallback10< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10 >::__evalcall(), urbi::UFCallback10< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10 >::__evalcall(), urbi::UCallback11< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11 >::__evalcall(), urbi::UFCallback11< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11 >::__evalcall(), urbi::UCallback12< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12 >::__evalcall(), urbi::UFCallback12< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12 >::__evalcall(), urbi::UCallback13< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13 >::__evalcall(), urbi::UFCallback13< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13 >::__evalcall(), urbi::UCallback14< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14 >::__evalcall(), urbi::UFCallback14< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14 >::__evalcall(), urbi::UCallback15< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15 >::__evalcall(), urbi::UFCallback15< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15 >::__evalcall(), urbi::UCallback16< OBJ, R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16 >::__evalcall(), urbi::UFCallback16< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, P15, P16 >::__evalcall(), urbi::UBoostFunctionCallback0< R >::__evalcall(), urbi::UBoostFunctionCallback1< R, P1 >::__evalcall(), urbi::UBoostFunctionCallback2< R, P1, P2 >::__evalcall(), urbi::UBoostFunctionCallback3< R, P1, P2, P3 >::__evalcall(), urbi::UBoostFunctionCallback4< R, P1, P2, P3, P4 >::__evalcall(), urbi::UBoostFunctionCallback5< R, P1, P2, P3, P4, P5 >::__evalcall(), urbi::UBoostFunctionCallback6< R, P1, P2, P3, P4, P5, P6 >::__evalcall(), urbi::UBoostFunctionCallback7< R, P1, P2, P3, P4, P5, P6, P7 >::__evalcall(), urbi::UBoostFunctionCallback8< R, P1, P2, P3, P4, P5, P6, P7, P8 >::__evalcall(), urbi::UBoostFunctionCallback9< R, P1, P2, P3, P4, P5, P6, P7, P8, P9 >::__evalcall(), urbi::UBoostFunctionCallback10< R, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10 >::__evalcall(), urbi::UEvent::__init(), urbi::UVar::__init(), call(), urbi::impl::RemoteUObjectImpl::clean(), urbi::impl::RemoteUVarImpl::clean(), urbi::UEvent::emit(), getIoService(), urbi::impl::RemoteUVarImpl::getProp(), getRunningMode(), getUObject(), getUObjectHub(), urbi::UEvent::init(), urbi::UVar::init(), urbi::impl::RemoteUObjectImpl::initialize(), urbi::impl::RemoteUGenericCallbackImpl::initialize(), kernelVersion(), urbi::impl::RemoteUObjectImpl::onUpdate(), urbi::InputPort::operator=(), urbi::impl::RemoteUGenericCallbackImpl::registerCallback(), urbi::impl::RemoteUObjectImpl::removeTimer(), urbi::impl::RemoteUVarImpl::request(), send(), urbi::impl::RemoteUVarImpl::set(), urbi::impl::RemoteUVarImpl::setInputPort(), urbi::impl::RemoteUVarImpl::setProp(), side_effect_free_get(), side_effect_free_set(), urbi::impl::RemoteUVarImpl::sync(), urbi::impl::RemoteUVarImpl::transmit(), urbi::impl::RemoteUVarImpl::transmitSerialized(), urbi::UGenericCallback::UGenericCallback(), urbi::impl::RemoteUVarImpl::unnotify(), uobject_unarmorAndSend(), urbi::UObjectHub::UObjectHub(), urbi::impl::RemoteUVarImpl::useRTP(), urbi::UObjectHub::USetUpdate(), yield(), yield_for(), yield_until(), yield_until_things_changed(), and urbi::UObjectHub::~UObjectHub().

The documentation for this class was generated from the following files:

urbi
UContext

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by 1.7.5.1