upipe/urefcount.h header reference

Upipe thread-safe reference counting More

• upipe/ubase.h
• upipe/uatomic.h

• struct urefcount
• typedef void (*urefcount_cb)(struct urefcount *)

• void urefcount_clean(struct urefcount *refcount)
• bool urefcount_dead(struct urefcount *refcount)
• void urefcount_init(struct urefcount *refcount, urefcount_cb cb)
• void urefcount_release(struct urefcount *refcount)
• void urefcount_reset(struct urefcount *refcount)
• bool urefcount_single(struct urefcount *refcount)
• struct urefcount * urefcount_use(struct urefcount *refcount)

Upipe thread-safe reference counting

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

This struct is declared in upipe/urefcount.h source file, line 50.

This struct defines an object with reference counting.

This typedef is declared in upipe/urefcount.h source file, line 47.

This typedef is a function pointer freeing a structure.

This function is declared in upipe/urefcount.h source file, line 134.

This function cleans up the urefcount structure.

Parameters list:

• refcount: pointer to a urefcount structure

This function is declared in upipe/urefcount.h source file, line 124.

This function checks for no reference.

Parameters list:

• refcount: pointer to a urefcount structure

The return value is true if there is no reference to the object

This function is declared in upipe/urefcount.h source file, line 64.

This function initializes a urefcount. It must be executed before any other call to the refcount structure.

Parameters list:

• refcount: pointer to a urefcount structure
• cb: function called when the refcount goes down to 0 (may be NULL)

This function is declared in upipe/urefcount.h source file, line 98.

This function decrements a reference counter, and possibly frees the object if the refcount goes down to 0.

Parameters list:

• refcount: pointer to a urefcount structure

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

This function resets a urefcount to 1.

Parameters list:

• refcount: pointer to a urefcount structure

This function is declared in upipe/urefcount.h source file, line 113.

This function checks for more than one reference.

Parameters list:

• refcount: pointer to a urefcount structure

The return value is true if there is only one reference to the object

This function is declared in upipe/urefcount.h source file, line 86.

This function increments a reference counter.

Parameters list:

• refcount: pointer to a urefcount structure

The return value is same pointer to a urefcount structure