User Tools

Site Tools


pom-ng:lua

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
pom-ng:lua [2015/07/29 14:03]
gmsoft Add event filters
pom-ng:lua [2015/08/10 10:48]
gmsoft [pload] Add filename
Line 278: Line 278:
 Called when an instance of the output is started. This function must be implemented by addon. Called when an instance of the output is started. This function must be implemented by addon.
  
-=== output:​pload_listen_start(open_function,​ write_function,​ close_function) ===+=== output:​pload_listen_start(open_function,​ write_function,​ close_function, filter) ===
 Start listening to payloads. Every payload will be processed. It's up to the output to filter them. If you don't need a specific function, you can specify nil instead. Start listening to payloads. Every payload will be processed. It's up to the output to filter them. If you don't need a specific function, you can specify nil instead.
  
Line 285: Line 285:
   * //​write_function//:​ Function that will be called when new data from a payload are available. Its prototype is write_function(payload_priv,​ payload_data). It must return **true** to continue processing the payload, other **false**.   * //​write_function//:​ Function that will be called when new data from a payload are available. Its prototype is write_function(payload_priv,​ payload_data). It must return **true** to continue processing the payload, other **false**.
   * //​close_function//:​ Function that will be called once a payload has been fully processed. Its prototype is close_function(payload_priv).   * //​close_function//:​ Function that will be called once a payload has been fully processed. Its prototype is close_function(payload_priv).
 +  * //filter//: Pload filter to use, optional.
  
 == Parameters of the above functions: == == Parameters of the above functions: ==
Line 311: Line 312:
 == Returns: == == Returns: ==
 Returns the event related to this payload. Returns the event related to this payload.
 +
 +=== pload.filename ===
 +
 +== Returns: ==
 +Returns the pload filename if it has been set, nil otherwise.
  
 === pload.parent === === pload.parent ===
pom-ng/lua.txt ยท Last modified: 2020/05/26 21:59 (external edit)