types.h File Reference

#include <boost/bind.hpp>
#include <boost/function.hpp>
#include <boost/make_shared.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread.hpp>
#include <boost/uuid/uuid.hpp>
#include <boost/uuid/uuid_io.hpp>
#include <boost/weak_ptr.hpp>
#include <funapi/network/fun_message.pb.h>
#include <funapi/win_headers.h>
#include <stdint.h>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	fun::ArrayDeleter< T >

Macros
#define	ASSERT_NO_ROLLBACK
#define	DECLARE_CLASS_PTR(CLS)
	Utility macro to forward-declare smart pointer types for a given class. More...
#define	DECLARE_EVENT(Event)   typedef fun::function<fun::ChainAction (Ptr<const Event>)> Handler;
	Utility macro to define a Funapi event type. More...
#define	DEFINE_CLASS_PTR(CLS)
	Utility macro to define smart pointer types for a given class. More...
#define	DEPRECATED(func)   func __attribute__((deprecated))
#define	FUNAPI_DLL_VISIBILITY
#define	FUNAPI_DLL_VISIBLE
#define	Ptr   boost::shared_ptr
#define	ROLLBACK
#define	WeakPtr   boost::weak_ptr

Typedefs
typedef std::string	fun::string
	String type used throughout Funapi.
typedef boost::uuids::uuid	fun::Uuid
	UUID type used throughout Funapi.

Enumerations
enum	fun::ChainAction { CONTINUE = 0, fun::STOP, fun::NULLIFY, fun::ABORT }
	Action types to specify behavior in chained operations (i.e. More...

Macro Definition Documentation

DECLARE_CLASS_PTR

#define DECLARE_CLASS_PTR

(

CLS

)

Value:

static const Ptr<CLS> kNullPtr; \
  static const WeakPtr<CLS> kNullWeakPtr;

Parameters

CLS	Class name.

See also

DEFINE_CLASS_PTR(CLS)

DECLARE_EVENT

#define DECLARE_EVENT

(

Event

)

typedef fun::function<fun::ChainAction (Ptr<const Event>)> Handler;

Event is simply a class that provides Handler interface.

Parameters

Event

Event name

DEFINE_CLASS_PTR

#define DEFINE_CLASS_PTR

(

CLS

)

Value:

const Ptr<CLS> CLS::kNullPtr; \
  const WeakPtr<CLS> CLS::kNullWeakPtr;

A class called DECLARE_CLASS_PTR(CLS) should also call this macro.

Parameters

CLS	Class name.

See also

DECLARE_CLASS_PTR(CLS)

Enumeration Type Documentation

ChainAction

enum fun::ChainAction

handlers). If CONTINUE is returned by a current handler, operation chain keeps being evaluated. Otherwise, chain evaluation stops after a current handler.

Enumerator
STOP	< Keeps traversing an operations chain.
NULLIFY	< Stops traversing an operations chain.
ABORT	< Stops traversing and nullify effects. Can be retried by calling Event::Resume() < Stops traversing and nullify effects.