YARP  2.3.68+283-20170530.4+git10f9853
Yet Another Robot Platform
yarp::os Namespace Reference

An interface to the operating system, including Port based communication. More...

Namespaces

 idl
 
 impl
 The components from which ports and connections are built.
 

Classes

class  AbstractCarrier
 A starter class for implementing simple carriers. More...
 
class  AbstractContactable
 A default implementation of an abstract port. More...
 
class  AbstractLockGuard
 This class is a mutex wrapper that provides a convenient RAII-style mechanism for owning a mutex for the duration of a scoped block. More...
 
class  BayerCarrier
 Decode bayer images and serve them as regular rgb. More...
 
class  BinPortable
 Class for writing and reading simple binary structures. More...
 
class  Bottle
 A simple collection of objects that can be described and transmitted in a portable way. More...
 
class  BufferedPort
 A mini-server for performing network communication in the background. More...
 
class  Bytes
 A simple abstraction for a block of bytes. More...
 
class  Carrier
 A base class for connection types (tcp, mcast, shmem, ...) which are called carriers in YARP. More...
 
class  Carriers
 Collection of carriers, a singleton. More...
 
class  Clock
 
class  Connection
 A controller for an individual connection. More...
 
class  ConnectionReader
 An interface for reading from a network connection. More...
 
class  ConnectionState
 The basic state of a connection - route, streams in use, etc. More...
 
class  ConnectionWriter
 An interface for writing to a network connection. More...
 
class  ConnectResult
 
class  ConstString
 A string with almost the same api as std::string. More...
 
class  Contact
 Represents how to reach a part of a YARP network. More...
 
class  Contactable
 An abstract port. More...
 
class  Contactables
 
class  ContactStyle
 Preferences for how to communicate with a contact. More...
 
class  DummyConnector
 A dummy connection to test yarp::os::Portable implementations. More...
 
class  ElectionOf
 Pick one of a set of peers to be "active". More...
 
class  Event
 A class for thread synchronization and mutual exclusion. More...
 
class  Face
 The initial point-of-contact with a port. More...
 
class  IConfig
 An object that can be configured. More...
 
class  InputProtocol
 The input side of an active connection between two ports. More...
 
class  InputStream
 Simple specification of the minimum functions needed from input streams. More...
 
class  LocalReader
 Under development. More...
 
class  Log
 
class  LogForwarder
 
class  LogStream
 
class  ManagedBytes
 An abstraction for a block of bytes, with optional responsibility for allocating/destroying that block. More...
 
class  MessageStack
 Maintain a stack of messages to send asynchronously. More...
 
class  MjpegCarrier
 A carrier for sending/receiving images via mjpeg over http. More...
 
class  MjpegStream
 
class  ModifyingCarrier
 A starter class for implementing simple modifying carriers. More...
 
class  MonitorObject
 
class  MpiBcastCarrier
 Carrier for port communicating via MPI broadcast. More...
 
class  MpiBcastStream
 Implements communication via MPI broadcast. More...
 
class  MpiCarrier
 Abstract base carrier for managing port communication via MPI. More...
 
class  MpiComm
 Wrapper for MPI_Comm communicator. More...
 
class  MpiControlThread
 
class  MpiP2PCarrier
 Carrier for port communicating via MPI point-to-point send/receive. More...
 
class  MpiP2PStream
 Implements communication via MPI point-to-point send/receive. More...
 
class  MpiStream
 Abstract base class for port communication via MPI. More...
 
class  MultiNameSpace
 
class  Mutex
 Basic wrapper for mutual exclusion. More...
 
class  Name
 Simple abstraction for a YARP port name. More...
 
class  NameSpace
 An abstract name space for ports. More...
 
class  NameStore
 Abstract interface for a database of port names. More...
 
class  NestedContact
 A placeholder for rich contact information. More...
 
class  NetType
 Various utilities related to types and formats. More...
 
class  Network
 Utilities for manipulating the YARP network, including initialization and shutdown. More...
 
class  NetworkBase
 Utilities for manipulating the YARP network, excluding initialization and shutdown. More...
 
class  NetworkClock
 
class  Node
 
class  Nodes
 
class  NullConnection
 
class  NullConnectionReader
 Dummy ConnectionReader that has no data. More...
 
class  NullConnectionWriter
 A dummy ConnectionWriter that consumes data without effect. More...
 
class  NullStream
 A "null" stream, always invalid. More...
 
class  OutputProtocol
 The output side of an active connection between two ports. More...
 
class  OutputStream
 Simple specification of the minimum functions needed from output streams. More...
 
class  PeerRecord
 
class  Ping
 Measure performance of a YARP port. More...
 
class  Port
 A mini-server for network communication. More...
 
class  Portable
 This is a base class for objects that can be both read from and be written to the YARP network. More...
 
class  PortablePair
 Group a pair of objects to be sent and received together. More...
 
class  PortablePairBase
 
class  PortInfo
 Information about a port connection or event. More...
 
class  PortMonitor
 Allow to monitor and modify port data from Lua script Under development. More...
 
class  PortMonitorGroup
 Manager for arbitration-aware inputs to a given port. More...
 
class  PortReader
 Interface implemented by all objects that can read themselves from the network, such as Bottle objects. More...
 
class  PortReaderBuffer
 Buffer incoming data to a port. More...
 
class  PortReaderCreator
 A creator for readers. More...
 
class  PortReport
 A base class for objects that want information about port status changes. More...
 
class  PortWriter
 Interface implemented by all objects that can write themselves to the network, such as Bottle objects. More...
 
class  PortWriterBuffer
 Buffer outgoing data to a port. More...
 
class  PortWriterBufferAdaptor
 
class  PriorityCarrier
 Allow priority-based message selection. More...
 
class  PriorityDebugThread
 
class  PriorityGroup
 Manager for priority-aware inputs to a given port. More...
 
class  Property
 A class for storing options and configuration information. More...
 
class  Publisher
 A port specialized for publishing data of a constant type on a topic. More...
 
class  QosStyle
 Preferences for the port's Quality of Service. More...
 
class  Random
 A collection of basic random number generation algorithms. More...
 
class  RateResult
 
class  RateThread
 An abstraction for a periodic thread. More...
 
class  RateThreadWrapper
 This class takes a Runnable instance and wraps a thread around it. More...
 
class  RecursiveMutex
 RecursiveMutex offers exclusive, recursive ownership semantics: More...
 
class  ResourceFinder
 Helper class for finding config files and other external resources. More...
 
class  ResourceFinderOptions
 These options are loosely based on http://wiki.icub.org/wiki/YARP_ResourceFinder. More...
 
class  RFModule
 A base-class for standard Yarp modules that supports ResourceFinder. More...
 
class  RosNameSpace
 
class  RosSrvCarrier
 
class  Route
 Information about a connection between two ports. More...
 
class  RpcClient
 A port that is specialized as an RPC client. More...
 
class  RpcServer
 A port that is specialized as an RPC server. More...
 
class  Run
 yarprun provides the APIs to a client-server environment that is able to run, kill and monitor applications commands on a remote machin in Windows and Linux. More...
 
class  Runnable
 A class that can be managed by another thread. More...
 
class  Searchable
 A base class for nested structures that can be searched. More...
 
class  Semaphore
 A class for thread synchronization and mutual exclusion. More...
 
class  SharedLibrary
 Low-level wrapper for loading shared libraries (DLLs) and accessing symbols within it. More...
 
class  SharedLibraryClass
 Container for an object created using a factory provided by a shared library. More...
 
struct  SharedLibraryClassApi
 Collection of hooks for creating/destroying a plugin. More...
 
class  SharedLibraryClassFactory
 A type-safe wrapper for SharedLibraryFactory, committing to creation/destruction of instances of a particular super-class. More...
 
class  SharedLibraryFactory
 A wrapper for a named factory method in a named shared library. More...
 
class  ShiftStream
 A container for a stream, allowing the stream implementation to be replaced when needed. More...
 
class  SizedWriter
 Minimal requirements for an efficient Writer. More...
 
class  Stamp
 An abstraction for a time stamp and/or sequence number. More...
 
class  Stamped
 A base class for objects with time stamps and/or sequence numbers. More...
 
class  Stat
 
class  StringInputStream
 An InputStream that reads from a string. More...
 
class  StringOutputStream
 An OutputStream that produces a string. More...
 
class  Subscriber
 A port specialized for reading data of a constant type published on a topic. More...
 
class  SystemClock
 
class  SystemInfo
 A class to get the system (platform) status such as available memory, storage, CPU load and etc. More...
 
class  SystemInfoSerializer
 A helper class to pass the SystemInfo object around the YARP network. More...
 
class  TcpRosCarrier
 
class  Terminator
 Send a message to a process that has a corresponding socket port created using the Terminee class to ask to start a graceful quit procedure. More...
 
class  Terminee
 A class that can be polled to see whether the process has been asked to quit gracefully. More...
 
class  Things
 Base class for generic things. More...
 
class  Thread
 An abstraction for a thread of execution. More...
 
class  Time
 Services related to time – delay, current time. More...
 
class  TwoWayStream
 A stream which can be asked to perform bidirectional communication. More...
 
class  Type
 
class  TypedReader
 A base class for sources of typed data. More...
 
class  TypedReaderCallback
 A callback for typed data from a port. More...
 
class  UnbufferedContactable
 An abstract unbuffered port. More...
 
class  Value
 A single value (typically within a Bottle). More...
 
class  Vocab
 Short readable codes. More...
 
class  Wire
 Base class for IDL client/server. More...
 
class  WireLink
 IDL-friendly object state, used in YARP to set up a port association. More...
 
class  XmlRpcCarrier
 This carrier enables XML/RPC message transmission. More...
 
class  XmlRpcStream
 
class  YarpDummyNameSpace
 
class  YarpNameSpace
 
class  YarpPlugin
 Type-safe access to a plugin. More...
 
class  YarpPluginSelector
 Pick out a set of relevant plugins. More...
 
class  YarpPluginSettings
 Collect hints for finding a particular plugin. More...
 

Typedefs

typedef AbstractLockGuard< MutexLockGuard
 
typedef AbstractLockGuard< RecursiveMutexRecursiveLockGuard
 
typedef void(* YarpSignalHandler) (int)
 

Enumerations

enum  {
  YARP_SIGTERM,
  YARP_SIGINT
}
 

Functions

YarpSignalHandler signal (int signum, YarpSignalHandler sighandler)
 Wrapper for the ACE_OS::signal signal. More...
 
void exit (int v)
 Wrapper for ACE_OS::exit(). More...
 
void abort (bool verbose=false)
 Wrapper for ACE_OS::abort(). More...
 
const char * getenv (const char *var)
 Wrapper for ACE_OS::getenv(). More...
 
int getpid ()
 Wrapper for ACE_OS::getppid(). More...
 
void setprogname (const char *progname)
 Wrapper for ACE_OS::setprogname(). More...
 
void getprogname (char *progname, size_t size)
 Wrapper for ACE_OS::getprogname(). More...
 
void gethostname (char *hostname, size_t size)
 Wrapper for ACE_OS::hostname(). More...
 
int mkdir (const char *p)
 Wrapper for ACE_OS::mkdir(). More...
 
int mkdir_p (const char *p, int ignoreLevels=0)
 Create a directory and all parent directories needed. More...
 
int rmdir (const char *p)
 Wrapper for ACE_OS::rmdir(). More...
 
int rename (const char *oldname, const char *newname)
 Wrapper for ACE_OS::rename(). More...
 
int stat (const char *path)
 Wrapper for ACE_OS::stat() function. More...
 
std::istream & operator>> (std::istream &stream, yarp::os::ConstString &str)
 Extract string from stream. More...
 
std::ostream & operator<< (std::ostream &stream, const yarp::os::ConstString &str)
 Insert string into stream. More...
 
yarp::os::ConstString operator+ (const yarp::os::ConstString &lhs, const yarp::os::ConstString &rhs)
 Concatenate ConstString. More...
 
yarp::os::ConstString operator+ (const yarp::os::ConstString &lhs, const char *rhs)
 
yarp::os::ConstString operator+ (const char *lhs, const yarp::os::ConstString &rhs)
 
yarp::os::ConstString operator+ (const yarp::os::ConstString &lhs, char rhs)
 
yarp::os::ConstString operator+ (char lhs, const yarp::os::ConstString &rhs)
 
bool operator== (const yarp::os::ConstString &lhs, const yarp::os::ConstString &rhs)
 Relational operations for ConstString. More...
 
bool operator== (const char *lhs, const yarp::os::ConstString &rhs)
 
bool operator== (const yarp::os::ConstString &lhs, const char *rhs)
 
bool operator!= (const yarp::os::ConstString &lhs, const yarp::os::ConstString &rhs)
 
bool operator!= (const char *lhs, const yarp::os::ConstString &rhs)
 
bool operator!= (const yarp::os::ConstString &lhs, const char *rhs)
 
bool operator< (const yarp::os::ConstString &lhs, const yarp::os::ConstString &rhs)
 
bool operator< (const char *lhs, const yarp::os::ConstString &rhs)
 
bool operator< (const yarp::os::ConstString &lhs, const char *rhs)
 
bool operator<= (const yarp::os::ConstString &lhs, const yarp::os::ConstString &rhs)
 
bool operator<= (const char *lhs, const yarp::os::ConstString &rhs)
 
bool operator<= (const yarp::os::ConstString &lhs, const char *rhs)
 
bool operator> (const yarp::os::ConstString &lhs, const yarp::os::ConstString &rhs)
 
bool operator> (const char *lhs, const yarp::os::ConstString &rhs)
 
bool operator> (const yarp::os::ConstString &lhs, const char *rhs)
 
bool operator>= (const yarp::os::ConstString &lhs, const yarp::os::ConstString &rhs)
 
bool operator>= (const char *lhs, const yarp::os::ConstString &rhs)
 
bool operator>= (const yarp::os::ConstString &lhs, const char *rhs)
 

Detailed Description

An interface to the operating system, including Port based communication.

Typedef Documentation

◆ LockGuard

Definition at line 18 of file LockGuard.h.

◆ RecursiveLockGuard

◆ YarpSignalHandler

typedef void(* yarp::os::YarpSignalHandler) (int)

Definition at line 23 of file Os.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
YARP_SIGTERM 
YARP_SIGINT 

Definition at line 17 of file Os.h.

Function Documentation

◆ abort()

void yarp::os::abort ( bool  verbose = false)

Wrapper for ACE_OS::abort().

Definition at line 43 of file Os.cpp.

◆ exit()

void yarp::os::exit ( int  v)

Wrapper for ACE_OS::exit().

Examples:
cuda/cuda_gpu.cpp, external/nameclient.c, framerate/main.cpp, and property/main.cpp.

Definition at line 37 of file Os.cpp.

◆ getenv()

const char * yarp::os::getenv ( const char *  var)

Wrapper for ACE_OS::getenv().

Parameters
varstring that containt the environment variable name
Returns
the value corresponding to the envarionment variable v

Definition at line 56 of file Os.cpp.

◆ gethostname()

void yarp::os::gethostname ( char *  hostname,
size_t  size 
)

Wrapper for ACE_OS::hostname().

Returns
the system hostname

Definition at line 134 of file Os.cpp.

◆ getpid()

int yarp::os::getpid ( )

Wrapper for ACE_OS::getppid().

Returns
the process id (pid)

Definition at line 99 of file Os.cpp.

◆ getprogname()

void yarp::os::getprogname ( char *  progname,
size_t  size 
)

Wrapper for ACE_OS::getprogname().

Returns
the program name

Definition at line 115 of file Os.cpp.

◆ mkdir()

int yarp::os::mkdir ( const char *  p)

Wrapper for ACE_OS::mkdir().

Create a directory.

Parameters
pname of the new directory.

Definition at line 61 of file Os.cpp.

◆ mkdir_p()

int yarp::os::mkdir_p ( const char *  p,
int  ignoreLevels = 0 
)

Create a directory and all parent directories needed.

Parameters
pdesired path
ignoreLevelscomponents of name to ignore. Set to 1 if last element of path is a filename, for example.
Returns
0 on success

Definition at line 70 of file Os.cpp.

◆ operator!=() [1/3]

bool yarp::os::operator!= ( const yarp::os::ConstString lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 498 of file ConstString.h.

◆ operator!=() [2/3]

bool yarp::os::operator!= ( const char *  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 503 of file ConstString.h.

◆ operator!=() [3/3]

bool yarp::os::operator!= ( const yarp::os::ConstString lhs,
const char *  rhs 
)
inline

Definition at line 508 of file ConstString.h.

◆ operator+() [1/5]

yarp::os::ConstString yarp::os::operator+ ( const yarp::os::ConstString lhs,
const yarp::os::ConstString rhs 
)
inline

Concatenate ConstString.

Definition at line 453 of file ConstString.h.

◆ operator+() [2/5]

yarp::os::ConstString yarp::os::operator+ ( const yarp::os::ConstString lhs,
const char *  rhs 
)
inline

Definition at line 458 of file ConstString.h.

◆ operator+() [3/5]

yarp::os::ConstString yarp::os::operator+ ( const char *  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 463 of file ConstString.h.

◆ operator+() [4/5]

yarp::os::ConstString yarp::os::operator+ ( const yarp::os::ConstString lhs,
char  rhs 
)
inline

Definition at line 468 of file ConstString.h.

◆ operator+() [5/5]

yarp::os::ConstString yarp::os::operator+ ( char  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 473 of file ConstString.h.

◆ operator<() [1/3]

bool yarp::os::operator< ( const yarp::os::ConstString lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 513 of file ConstString.h.

◆ operator<() [2/3]

bool yarp::os::operator< ( const char *  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 518 of file ConstString.h.

◆ operator<() [3/3]

bool yarp::os::operator< ( const yarp::os::ConstString lhs,
const char *  rhs 
)
inline

Definition at line 523 of file ConstString.h.

◆ operator<<()

std::ostream& yarp::os::operator<< ( std::ostream &  stream,
const yarp::os::ConstString str 
)
inline

Insert string into stream.

Definition at line 442 of file ConstString.h.

◆ operator<=() [1/3]

bool yarp::os::operator<= ( const yarp::os::ConstString lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 528 of file ConstString.h.

◆ operator<=() [2/3]

bool yarp::os::operator<= ( const char *  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 533 of file ConstString.h.

◆ operator<=() [3/3]

bool yarp::os::operator<= ( const yarp::os::ConstString lhs,
const char *  rhs 
)
inline

Definition at line 538 of file ConstString.h.

◆ operator==() [1/3]

bool yarp::os::operator== ( const yarp::os::ConstString lhs,
const yarp::os::ConstString rhs 
)
inline

Relational operations for ConstString.

Definition at line 483 of file ConstString.h.

◆ operator==() [2/3]

bool yarp::os::operator== ( const char *  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 488 of file ConstString.h.

◆ operator==() [3/3]

bool yarp::os::operator== ( const yarp::os::ConstString lhs,
const char *  rhs 
)
inline

Definition at line 493 of file ConstString.h.

◆ operator>() [1/3]

bool yarp::os::operator> ( const yarp::os::ConstString lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 543 of file ConstString.h.

◆ operator>() [2/3]

bool yarp::os::operator> ( const char *  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 548 of file ConstString.h.

◆ operator>() [3/3]

bool yarp::os::operator> ( const yarp::os::ConstString lhs,
const char *  rhs 
)
inline

Definition at line 553 of file ConstString.h.

◆ operator>=() [1/3]

bool yarp::os::operator>= ( const yarp::os::ConstString lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 558 of file ConstString.h.

◆ operator>=() [2/3]

bool yarp::os::operator>= ( const char *  lhs,
const yarp::os::ConstString rhs 
)
inline

Definition at line 563 of file ConstString.h.

◆ operator>=() [3/3]

bool yarp::os::operator>= ( const yarp::os::ConstString lhs,
const char *  rhs 
)
inline

Definition at line 568 of file ConstString.h.

◆ operator>>()

std::istream& yarp::os::operator>> ( std::istream &  stream,
yarp::os::ConstString str 
)
inline

Extract string from stream.

Definition at line 431 of file ConstString.h.

◆ rename()

int yarp::os::rename ( const char *  oldname,
const char *  newname 
)

Wrapper for ACE_OS::rename().

Changes the name of the file or directory specified by oldname to newname.

Parameters
oldnameold name of the file/directory.
newnamenew name of the file/directory.

Definition at line 84 of file Os.cpp.

◆ rmdir()

int yarp::os::rmdir ( const char *  p)

Wrapper for ACE_OS::rmdir().

Remove an empty directory.

Parameters
pname of the directory.

Definition at line 75 of file Os.cpp.

◆ setprogname()

void yarp::os::setprogname ( const char *  progname)

Wrapper for ACE_OS::setprogname().

Parameters
prognamethe program name

Definition at line 105 of file Os.cpp.

◆ signal()

yarp::os::YarpSignalHandler yarp::os::signal ( int  signum,
YarpSignalHandler  sighandler 
)

Wrapper for the ACE_OS::signal signal.

Attach a function handler to a signal.

Parameters
signumsignal number (e.g. SIGTERM/SIGINT) to handle
sighandlerhandler function
Examples:
framerate/main.cpp.

Definition at line 24 of file Os.cpp.

◆ stat()

int yarp::os::stat ( const char *  path)

Wrapper for ACE_OS::stat() function.

Definition at line 93 of file Os.cpp.