upipe/upipe_dump.h header reference

Upipe pipeline dumping for debug purposes More

Header inclusion  

Members  

Types  

Functions  

  • void upipe_dump(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, FILE *file, struct uchain *ulist, ...)
  • char * upipe_dump_flow_def_label_default(struct uref *flow_def)
  • int upipe_dump_open(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, const char *path, struct uchain *ulist, ...)
  • int upipe_dump_open_va(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, const char *path, struct uchain *ulist, va_list args)
  • char * upipe_dump_upipe_label_default(struct upipe *upipe)
  • void upipe_dump_va(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, FILE *file, struct uchain *ulist, va_list args)

Description  

Upipe pipeline dumping for debug purposes

Members detail  

#define _UPIPE_UPIPE_DUMP_H_  

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

void upipe_dump(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, FILE *file, struct uchain *ulist, ...)  

This function is declared in upipe/upipe_dump.h source file, line 83.

This function dumps a pipeline in dot format with a variable list of arguments.

Parameter list:

  • pipe_label: function to print pipe labels
  • flow_def_label: function to print flow_def labels
  • file: file pointer to write to
  • ulist: list of sources pipes in ulist format, followed by a list of source pipes terminated by NULL

typedef char *(upipe_dump_flow_def_label)(struct uref *)   

This typedef is declared in upipe/upipe_dump.h source file, line 44.

This typedef represents a dumping function for flow def labels.

char * upipe_dump_flow_def_label_default(struct uref *flow_def)  

This function is declared in upipe/upipe_dump.h source file, line 58.

This function converts a flow def to a label (default function).

Parameter list:

  • flow_def: flow definition packet

The return value is allocated string

int upipe_dump_open(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, const char *path, struct uchain *ulist, ...)  

This function is declared in upipe/upipe_dump.h source file, line 116.

This function opens a file and dumps a pipeline in dot format with a variable list of arguments.

Parameter list:

  • pipe_label: function to print pipe labels
  • flow_def_label: function to print flow_def labels
  • path: path of the file to open
  • ulist: list of sources pipes in ulist format, followed by a list of source pipes terminated by NULL

The return value is an error code

int upipe_dump_open_va(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, const char *path, struct uchain *ulist, va_list args)  

This function is declared in upipe/upipe_dump.h source file, line 101.

This function opens a file and dumps a pipeline in dot format.

Parameter list:

  • pipe_label: function to print pipe labels
  • flow_def_label: function to print flow_def labels
  • path: path of the file to open
  • ulist: list of sources pipes in ulist format
  • args: list of sources pipes terminated with NULL

The return value is an error code

typedef char *(upipe_dump_pipe_label)(struct upipe *)   

This typedef is declared in upipe/upipe_dump.h source file, line 41.

This typedef represents a dumping function for pipe labels.

char * upipe_dump_upipe_label_default(struct upipe *upipe)  

This function is declared in upipe/upipe_dump.h source file, line 51.

This function converts a pipe to a label (default function).

Parameter list:

  • upipe: upipe structure

The return value is allocated string

void upipe_dump_va(upipe_dump_pipe_label pipe_label, upipe_dump_flow_def_label flow_def_label, FILE *file, struct uchain *ulist, va_list args)  

This function is declared in upipe/upipe_dump.h source file, line 70.

This function dumps a pipeline in dot format.

Parameter list:

  • pipe_label: function to print pipe labels
  • flow_def_label: function to print flow_def labels
  • file: file pointer to write to
  • ulist: list of sources pipes in ulist format
  • args: list of sources pipes terminated with NULL

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