upipe/uprobe_uclock.h header reference

probe catching need_uclock events and providing a given uclock More

Header inclusion  

Members  

Type  

Functions  

Description  

probe catching need_uclock events and providing a given uclock

Members detail  

#define _UPIPE_UPROBE_UCLOCK_H_  

This macro is declared in upipe/uprobe_uclock.h source file, line 31.

struct uprobe_uclock  

This struct is declared in upipe/uprobe_uclock.h source file, line 42.

This struct is a super-set of the uprobe structure with additional local members.

FieldDescription
struct uclock *uclock;pointer to uclock to provide
struct uprobe uprobe;structure exported to modules

struct uprobe * uprobe_uclock_alloc(struct uprobe *next, struct uclock *uclock)  

This function is declared in upipe/uprobe_uclock.h source file, line 75.

This function allocates a new uprobe_uclock structure.

Parameters list:

  • next: next probe to test if this one doesn't catch the event
  • uclock: uref manager to provide to pipes

The return value is pointer to uprobe, or NULL in case of error

void uprobe_uclock_clean(struct uprobe_uclock *uprobe_uclock)  

This function is declared in upipe/uprobe_uclock.h source file, line 67.

This function cleans a uprobe_uclock structure.

Parameters list:

  • uprobe_uclock: structure to clean

struct uprobe * uprobe_uclock_init(struct uprobe_uclock *uprobe_uclock, struct uprobe *next, struct uclock *uclock)  

This function is declared in upipe/uprobe_uclock.h source file, line 61.

This function initializes an already allocated uprobe_uclock structure.

Parameters list:

  • uprobe_uclock: pointer to the already allocated structure
  • next: next probe to test if this one doesn't catch the event
  • uclock: uref manager to provide to pipes

The return value is pointer to uprobe, or NULL in case of error

void uprobe_uclock_set(struct uprobe *uprobe, struct uclock *uclock)  

This function is declared in upipe/uprobe_uclock.h source file, line 82.

This function changes the uclock set by this probe.

Parameters list:

  • uprobe: pointer to probe
  • uclock: new uref manager to provide to pipes

struct uprobe_uclock * uprobe_uclock_from_uprobe(struct uprobe *uprobe)  

This function is for internal use only.

This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 18 in upipe/uprobe_uclock.h source file, line 50.

This function returns the private uprobe_uclock structure.

Parameters list:

  • uprobe: public description structure of the probe

The return value is pointer to the private uprobe_uclock structure

struct uprobe * uprobe_uclock_to_uprobe(struct uprobe_uclock *s)  

This function is for internal use only.

This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 8 in upipe/uprobe_uclock.h source file, line 50.

This function returns the public uprobe structure.

Parameters list:

  • uprobe_uclock: pointer to the private uprobe_uclock structure

The return value is pointer to the public uprobe structure

Valid XHTML 1.0 StrictGenerated by cmassiot on Thu Nov 6 12:15:40 2014 using MkDoc