upipe-modules/upipe_http_source.h header reference

Upipe source module for http GET requests More

Header inclusion  

Members  

Types  

Functions  

Description  

Upipe source module for http GET requests

Members detail  

#define UPIPE_HTTP_SRC_SIGNATURE  

This macro is declared in upipe-modules/upipe_http_source.h source file, line 38.

#define _UPIPE_MODULES_UPIPE_HTTP_SOURCE_H_  

This macro is declared in upipe-modules/upipe_http_source.h source file, line 31.

enum upipe_http_src_command  

This enum is declared in upipe-modules/upipe_http_source.h source file, line 96.

This enum extends upipe_command with specific commands for http source.

IdentifierValueDescription
UPIPE_HTTP_SRC_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_HTTP_SRC_SET_PROXYunknownset the http proxy to use (const char *)

const char * upipe_http_src_command_str(int cmd)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 109.

This function converts an enum upipe_http_src_command to a string.

Parameter list:

  • cmd: the enum to convert

The return value is a string

struct upipe_mgr * upipe_http_src_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_http_source.h source file, line 205.

This function returns the management structure for all http sources.

The return value is pointer to manager

enum upipe_http_src_mgr_command  

This enum is declared in upipe-modules/upipe_http_source.h source file, line 131.

This enum extends upipe_mgr_command with specific commands for http source.

IdentifierValueDescription
UPIPE_HTTP_SRC_MGR_SENTINELUPIPE_MGR_CONTROL_LOCAL
UPIPE_HTTP_SRC_MGR_GET_PROXYunknownget the proxy url (const char **)
UPIPE_HTTP_SRC_MGR_SET_PROXYunknownset the proxy url (const char *)
UPIPE_HTTP_SRC_MGR_SET_COOKIEunknownadd a cookie (const char *)
UPIPE_HTTP_SRC_MGR_ITERATE_COOKIEunknowniterate over cookies

int upipe_http_src_mgr_get_proxy(struct upipe_mgr *mgr, const char **proxy_p)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 166.

This function gets the proxy url to use by default for the new allocated pipes.

Parameter list:

  • mgr: pointer to upipe manager
  • proxy_p: a pointer the proxy url

The return value is an error code

int upipe_http_src_mgr_iterate_cookie(struct upipe_mgr *mgr, const char *domain, const char *path, struct uchain **uchain_p)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 196.

This function iterates over the manager cookie list.

Parameter list:

  • mgr: pointer to upipe manager
  • domain: the domain to match
  • path: the path to match
  • uchain_p: iterator

The return value is an error code

int upipe_http_src_mgr_set_cookie(struct upipe_mgr *mgr, const char *string)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 179.

This function adds a cookie in the manager cookie list.

Parameter list:

  • mgr: pointer to upipe manager
  • string: the cookie string to add

The return value is an error code

int upipe_http_src_mgr_set_proxy(struct upipe_mgr *mgr, const char *proxy)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 153.

This function sets the proxy url to use by default for the new allocated pipes.

Parameter list:

  • mgr: pointer to upipe manager
  • proxy: the proxy url

The return value is an error code

int upipe_http_src_set_proxy(struct upipe *upipe, const char *proxy)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 125.

This function sets the http proxy to use.

Parameter list:

  • upipe: description structure of the pipe
  • proxy: the proxy url

The return value is an error code

int upipe_http_src_throw_error(struct upipe *upipe, unsigned int code)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 89.

This function throw an error code event.

Parameter list:

  • upipe: description structure of the pipe
  • code: HTTP error code

The return value is an error code

int upipe_http_src_throw_redirect(struct upipe *upipe, const char *uri)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 76.

This function throw a redirect event.

Parameter list:

  • upipe: description structure of the pipe
  • uri: the temporary uri

The return value is an error code

enum uprobe_http_src_event  

This enum is declared in upipe-modules/upipe_http_source.h source file, line 42.

This enum extends uprobe_event with specific events for http source.

IdentifierValueDescription
UPROBE_HTTP_SRC_SENTINELUPROBE_LOCAL
UPROBE_HTTP_SRC_REDIRECTunknownrequest receive a redirect (302) response with the url (const char *)
UPROBE_HTTP_SRC_ERRORunknownrequest receive an error code response with the error code (unsigned int)

const char * uprobe_http_src_event_str(int event)  

This function is declared in upipe-modules/upipe_http_source.h source file, line 59.

This function converts an enum uprobe_http_src_event to a string.

Parameter list:

  • event: the enum to convert

The return value is a string

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:18 2018 using MkDoc