RegLogConnector {shiny.reglog} | R Documentation |
RegLog connector template
Description
Parent class for all RegLog connectors
Public fields
module_id
character vector specifying the automatically-generated module_id for listener server module
listener
reactiveVal that the object keeps listening of changes for
message
reactiveVal containing outward message
log
list containing data about received and sent messages by the object
handlers
named list containing functions used to handle different types of
RegLogConnectorMessage
. Name of the element corresponds to the 'type' that is should handle.
Methods
Public methods
Method get_logs()
Function to receive all saved logs from the object in the form of single data.frame
Usage
RegLogConnector$get_logs()
Details
You can specify custom handler functions as a named list passed
to custom_handlers
arguments during object initialization. Every custom
handler should take arguments: self
and private
- relating to the R6
object and message
of class RegLogConnectorMessage
. It should return
RegLogConnectorMessage
object.
Returns
data.frame
Method new()
Initialization of the object. Sets up listener reactiveVal and initializes listening server module
Usage
RegLogConnector$new(custom_handlers = NULL)
Arguments
custom_handlers
named list of custom handler functions. Every custom handler should take arguments:
self
andprivate
- relating to the R6 object andmessage
of classRegLogConnectorMessage
. It should returnRegLogConnectorMessage
object.
Returns
object of RegLogConnector
class
Method suspend()
Suspend the listening to the changes
Usage
RegLogConnector$suspend()
Method resume()
Resume the listening to the changes
Usage
RegLogConnector$resume()
Method clone()
The objects of this class are cloneable with this method.
Usage
RegLogConnector$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.