SyncEvent#

Modules#

Typedefs#

typedef union USyncEventFunctor

USyncEventFunctor

typedef struct SSyncEvent

SSyncEvent

typedef union USyncEventRetFunctor

USyncEventRetFunctor

typedef struct SSyncEventRet

SSyncEventRet

typedef union USyncEventArg1Functor

USyncEventArg1Functor

typedef struct SSyncEventArg1

SSyncEventArg1

typedef union USyncEventArg2Functor

USyncEventArg2Functor

typedef struct SSyncEventArg2

SSyncEventArg2

Functions#

bool

SyncEventIsBound(const SSyncEvent *pThis)

Returns if SyncEvent is bound.

void

SyncEventUnbind(SSyncEvent *pThis)

Unbind the SyncEvent.

void

SyncEventBind(SSyncEvent *pThis, void(*pFunction)(void))

Bind the SyncEvent to a function.

void

SyncEventBindObject(SSyncEvent *pThis, void(*pFunction)(void *), void *pObject)

Bind the SyncEvent to a "class" function.

void

SyncEventInvoke(const SSyncEvent *pThis)

Invoke the SyncEvent.

bool

SyncEventRetIsBound(const SSyncEventRet *pThis)

Returns if SyncEvent is bound.

void

SyncEventRetUnbind(SSyncEventRet *pThis)

Unbind the SyncEvent.

void

SyncEventRetBind(SSyncEventRet *pThis, uint32_t(*pFunction)(void))

Bind the SyncEvent to a function.

void

SyncEventRetBindObject(SSyncEventRet *pThis, uint32_t(*pFunction)(void *), void *pObject)

Bind the SyncEvent to a "class" function.

uint32_t

SyncEventRetInvoke(const SSyncEventRet *pThis)

Invoke the SyncEvent.

void

SyncEventRetSetDefault(SSyncEventRet *pThis, uint32_t DefaultReturnValue)

Configure default return.

bool

SyncEventArg1IsBound(const SSyncEventArg1 *pThis)

Returns if SyncEvent is bound.

void

SyncEventArg1Unbind(SSyncEventArg1 *pThis)

Unbind the SyncEvent.

void

SyncEventArg1Bind(SSyncEventArg1 *pThis, void(*pFunction)(uint32_t))

Bind the SyncEvent to a function.

void

SyncEventArg1BindObject(SSyncEventArg1 *pThis, void(*pFunction)(void *, uint32_t), void *pObject)

Bind the SyncEvent to a "class" function.

void

SyncEventArg1Invoke(const SSyncEventArg1 *pThis, uint32_t Arg1)

Invoke the SyncEvent.

bool

SyncEventArg2IsBound(const SSyncEventArg2 *pThis)

Returns if SyncEvent is bound.

void

SyncEventArg2Unbind(SSyncEventArg2 *pThis)

Unbind the SyncEvent.

void

SyncEventArg2Bind(SSyncEventArg2 *pThis, void(*pFunction)(uint32_t, uint32_t))

Bind the SyncEvent to a function.

void

SyncEventArg2BindObject(SSyncEventArg2 *pThis, void(*pFunction)(void *, uint32_t, uint32_t), void *pObject)

Bind the SyncEvent to a "class" function.

void

SyncEventArg2Invoke(const SSyncEventArg2 *pThis, uint32_t Arg1, uint32_t Arg2)

Invoke the SyncEvent.

Typedef Documentation#

USyncEventFunctor#

typedef union USyncEventFunctor USyncEventFunctor

SSyncEvent#

typedef struct SSyncEvent SSyncEvent

USyncEventRetFunctor#

typedef union USyncEventRetFunctor USyncEventRetFunctor

SSyncEventRet#

typedef struct SSyncEventRet SSyncEventRet

USyncEventArg1Functor#

typedef union USyncEventArg1Functor USyncEventArg1Functor

SSyncEventArg1#

typedef struct SSyncEventArg1 SSyncEventArg1

USyncEventArg2Functor#

typedef union USyncEventArg2Functor USyncEventArg2Functor

SSyncEventArg2#

typedef struct SSyncEventArg2 SSyncEventArg2

Function Documentation#

SyncEventIsBound#

bool SyncEventIsBound (const SSyncEvent * pThis)

Returns if SyncEvent is bound.

Parameters

Type	Direction	Argument Name	Description
const SSyncEvent *	N/A	pThis	SyncEvent object structure.

SyncEventUnbind#

void SyncEventUnbind (SSyncEvent * pThis)

Unbind the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
SSyncEvent *	N/A	pThis	SyncEvent object structure.

Unbinds the SyncEvent. Once unbound there will be no action when invoked. It is crucial that Bind, BindObject or Unbind is called before first invoke (my kingdom for a constructor).

SyncEventBind#

void SyncEventBind (SSyncEvent * pThis, void(*)(void) pFunction)

Bind the SyncEvent to a function.

Parameters

Type	Direction	Argument Name	Description
SSyncEvent *	N/A	pThis	SyncEvent object structure.
void(*)(void)	N/A	pFunction	Function pointer to function of type: void Foo(void)

Binds the SyncEvent to a function. Once bound invocation will call function.

SyncEventBindObject#

void SyncEventBindObject (SSyncEvent * pThis, void(*)(void *) pFunction, void * pObject)

Bind the SyncEvent to a "class" function.

Parameters

Type	Direction	Argument Name	Description
SSyncEvent *	N/A	pThis	SyncEvent object structure.
void()(void )	N/A	pFunction	Function pointer to function of type: void Foo(FooObject*)
void *	N/A	pObject	Object pointer to pass as argument to bound function

Binds the SyncEvent to a function wich takes an object pointer or similar. Once bound invocation will call function with pointer as argument.

SyncEventInvoke#

void SyncEventInvoke (const SSyncEvent * pThis)

Invoke the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
const SSyncEvent *	N/A	pThis	SyncEvent object structure.

Invokes the SyncEvent. If the SyncEvent is not bound, nothing happens. If bound invocation will call function or Function with pointer as argument.

SyncEventRetIsBound#

bool SyncEventRetIsBound (const SSyncEventRet * pThis)

Returns if SyncEvent is bound.

Parameters

Type	Direction	Argument Name	Description
const SSyncEventRet *	N/A	pThis	SyncEvent object structure.

SyncEventRetUnbind#

void SyncEventRetUnbind (SSyncEventRet * pThis)

Unbind the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
SSyncEventRet *	N/A	pThis	SyncEvent object structure.

Unbinds the SyncEvent. Once unbound there will be no action when invoked. It is crucial that Bind, BindObject or Unbind is called before first invoke (my kingdom for a constructor).

SyncEventRetBind#

void SyncEventRetBind (SSyncEventRet * pThis, uint32_t(*)(void) pFunction)

Bind the SyncEvent to a function.

Parameters

Type	Direction	Argument Name	Description
SSyncEventRet *	N/A	pThis	SyncEvent object structure.
uint32_t(*)(void)	N/A	pFunction	Function pointer to function of type: uint32_t Foo(void)

Binds the SyncEvent to a function. Once bound invocation will call function.

SyncEventRetBindObject#

void SyncEventRetBindObject (SSyncEventRet * pThis, uint32_t(*)(void *) pFunction, void * pObject)

Bind the SyncEvent to a "class" function.

Parameters

Type	Direction	Argument Name	Description
SSyncEventRet *	N/A	pThis	SyncEvent object structure.
uint32_t()(void )	N/A	pFunction	Function pointer to function of type: uint32_t Foo(FooObject*)
void *	N/A	pObject	Object pointer to pass as argument to bound function

Binds the SyncEvent to a function wich takes an object pointer or similar. Once bound invocation will call function with pointer as argument.

SyncEventRetInvoke#

uint32_t SyncEventRetInvoke (const SSyncEventRet * pThis)

Invoke the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
const SSyncEventRet *	N/A	pThis	SyncEvent object structure.

Invokes the SyncEvent. If theSyncEvent is not bound, nothing happens. If bound invocation will call function or Function with pointer as argument.

SyncEventRetSetDefault#

void SyncEventRetSetDefault (SSyncEventRet * pThis, uint32_t DefaultReturnValue)

Configure default return.

Parameters

Type	Direction	Argument Name	Description
SSyncEventRet *	N/A	pThis	SyncEvent object structure.
uint32_t	N/A	DefaultReturnValue	Value returned when SyncEvent is invoked while unbound.

Configure the default return value that is returned when the SyncEvent is invoked while unbound.

SyncEventArg1IsBound#

bool SyncEventArg1IsBound (const SSyncEventArg1 * pThis)

Returns if SyncEvent is bound.

Parameters

Type	Direction	Argument Name	Description
const SSyncEventArg1 *	N/A	pThis	SyncEvent object structure.

SyncEventArg1Unbind#

void SyncEventArg1Unbind (SSyncEventArg1 * pThis)

Unbind the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
SSyncEventArg1 *	N/A	pThis	SyncEvent object structure.

Unbinds the SyncEvent. Once unbound there will be no action when invoked. It is crucial that Bind, BindObject or Unbind is called before first invoke (my kingdom for a constructor).

SyncEventArg1Bind#

void SyncEventArg1Bind (SSyncEventArg1 * pThis, void(*)(uint32_t) pFunction)

Bind the SyncEvent to a function.

Parameters

Type	Direction	Argument Name	Description
SSyncEventArg1 *	N/A	pThis	SyncEvent object structure.
void(*)(uint32_t)	N/A	pFunction	Function pointer to function of type: void Foo(uint32_t)

Binds the SyncEvent to a function. Once bound invocation will call function.

SyncEventArg1BindObject#

void SyncEventArg1BindObject (SSyncEventArg1 * pThis, void(*)(void *, uint32_t) pFunction, void * pObject)

Bind the SyncEvent to a "class" function.

Parameters

Type	Direction	Argument Name	Description
SSyncEventArg1 *	N/A	pThis	SyncEvent object structure.
void()(void , uint32_t)	N/A	pFunction	Function pointer to function of type: void Foo(FooObject*, uint32_t)
void *	N/A	pObject	Object pointer to pass as argument to bound function

Binds the SyncEvent to a function wich takes an object pointer or similar. Once bound invocation will call function with pointer as argument.

SyncEventArg1Invoke#

void SyncEventArg1Invoke (const SSyncEventArg1 * pThis, uint32_t Arg1)

Invoke the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
const SSyncEventArg1 *	N/A	pThis	SyncEvent object structure.
uint32_t	N/A	Arg1

Invokes the SyncEvent. If theSyncEvent is not bound, nothing happens. If bound invocation will call function or Function with pointer as argument.

SyncEventArg2IsBound#

bool SyncEventArg2IsBound (const SSyncEventArg2 * pThis)

Returns if SyncEvent is bound.

Parameters

Type	Direction	Argument Name	Description
const SSyncEventArg2 *	N/A	pThis	SyncEvent object structure.

SyncEventArg2Unbind#

void SyncEventArg2Unbind (SSyncEventArg2 * pThis)

Unbind the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
SSyncEventArg2 *	N/A	pThis	SyncEvent object structure.

Unbinds the SyncEvent. Once unbound there will be no action when invoked. It is crucial that Bind, BindObject or Unbind is called before first invoke (my kingdom for a constructor).

SyncEventArg2Bind#

void SyncEventArg2Bind (SSyncEventArg2 * pThis, void(*)(uint32_t, uint32_t) pFunction)

Bind the SyncEvent to a function.

Parameters

Type	Direction	Argument Name	Description
SSyncEventArg2 *	N/A	pThis	SyncEvent object structure.
void(*)(uint32_t, uint32_t)	N/A	pFunction	Function pointer to function of type: void Foo(uint32_t)

Binds the SyncEvent to a function. Once bound invocation will call function.

SyncEventArg2BindObject#

void SyncEventArg2BindObject (SSyncEventArg2 * pThis, void(*)(void *, uint32_t, uint32_t) pFunction, void * pObject)

Bind the SyncEvent to a "class" function.

Parameters

Type	Direction	Argument Name	Description
SSyncEventArg2 *	N/A	pThis	SyncEvent object structure.
void()(void , uint32_t, uint32_t)	N/A	pFunction	Function pointer to function of type: void Foo(FooObject*, uint32_t, uint32_t)
void *	N/A	pObject	Object pointer to pass as argument to bound function

Binds the SyncEvent to a function wich takes an object pointer or similar. Once bound invocation will call function with pointer as argument.

SyncEventArg2Invoke#

void SyncEventArg2Invoke (const SSyncEventArg2 * pThis, uint32_t Arg1, uint32_t Arg2)

Invoke the SyncEvent.

Parameters

Type	Direction	Argument Name	Description
const SSyncEventArg2 *	N/A	pThis	SyncEvent object structure.
uint32_t	N/A	Arg1
uint32_t	N/A	Arg2

Invokes the SyncEvent. If theSyncEvent is not bound, nothing happens. If bound invocation will call function or Function with pointer as argument.