upipe/uprobe_source_mgr.h header reference
probe providing source pipe manager by catching need source pipe More
Header inclusion [link]
Members [link]
Type [link]
- struct uprobe_source_mgr
Functions [link]
- struct uprobe * uprobe_source_mgr_alloc(struct uprobe *next, struct upipe_mgr *source_mgr)
- void uprobe_source_mgr_clean(struct uprobe_source_mgr *uprobe_source_mgr)
- struct uprobe * uprobe_source_mgr_init(struct uprobe_source_mgr *uprobe_source_mgr, struct uprobe *next, struct upipe_mgr *source_mgr)
Description [link]
manager events
Members detail [link]
#define _UPIPE_UPROBE_SOURCE_MGR_H_ [link]
This macro is declared in upipe/uprobe_source_mgr.h source file, line 30.
[link]
This struct is declared in upipe/uprobe_source_mgr.h source file, line 40.
| Field | Description |
|---|---|
| struct urefcount * refcount; | pointer to refcount management structure |
| unsigned int signature; | signature of the pipe allocator |
| const char *(*upipe_err_str)(int err); | function to get local error string |
| const char *(*upipe_command_str)(int command); | function to get local command string |
| const char *(*upipe_event_str)(int event); | function to get local event string |
| struct upipe *(*upipe_alloc)(struct upipe_mgr *, struct uprobe *, uint32_t va_list ) ; | function to create a pipe - uprobe belongs to the callee |
| void (*upipe_input)(struct upipe *, struct uref *, struct upump **) ; | function to send a uref to an input - the uref then belongs to the callee |
| int (*upipe_control)(struct upipe *, int va_list ) ; | control function for standard or local commands - all parameters belong to the caller |
| int (*upipe_mgr_control)(struct upipe_mgr *, int va_list ) ; | control function for standard or local manager commands - all parameters belong to the caller |
struct uprobe_source_mgr [link]
This struct is declared in upipe/uprobe_source_mgr.h source file, line 43.
This struct defines a source manager probe.
| Field | Description |
|---|---|
| struct upipe_mgr * source_mgr; | source manager to provide |
| struct uprobe uprobe; | public probe structure |
This function is declared in upipe/uprobe_source_mgr.h source file, line 78.
This function allocates and initializes a new uprobe_source_mgr structure.
Parameter list:
- next: next probe to test if this one doesn't catch the event
- source_mgr: source pipe manager to provide to pipes
The return value is pointer to uprobe, or NULL in case of error
void uprobe_source_mgr_clean(struct uprobe_source_mgr *uprobe_source_mgr) [link]
This function is declared in upipe/uprobe_source_mgr.h source file, line 68.
This function cleans a uprobe_source_mgr structure.
Parameter list:
- uprobe_source_mgr: structure to clean
struct uprobe * uprobe_source_mgr_init(struct uprobe_source_mgr *uprobe_source_mgr, struct uprobe *next, struct upipe_mgr *source_mgr) [link]
This function is declared in upipe/uprobe_source_mgr.h source file, line 62.
This function initializes an already allocated uprobe_source_mgr structure.
Parameter list:
- uprobe_source_mgr: pointer to the already allocated structure
- next: next probe to test if this one doesn't catch the event
- source_mgr: source pipe manager to provide to pipes
The return value is pointer to uprobe, or NULL in case of error
struct uprobe_source_mgr * uprobe_source_mgr_from_uprobe(struct uprobe *uprobe) [link]
This function is for internal use only.
This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 19 in upipe/uprobe_source_mgr.h source file, line 50.
This function returns the private uprobe_source_mgr structure.
Parameter list:
- uprobe: public description structure of the probe
The return value is pointer to the private uprobe_source_mgr structure
struct uprobe * uprobe_source_mgr_to_uprobe(struct uprobe_source_mgr *s) [link]
This function is for internal use only.
This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 9 in upipe/uprobe_source_mgr.h source file, line 50.
This function returns the public uprobe structure.
Parameter list:
- uprobe_source_mgr: pointer to the private uprobe_source_mgr structure
The return value is pointer to the public uprobe structure