Node Monitor v0.6.5


FileSyncProbe Class

Extends Probe
Module: Probes

Probe for synchronizing a Backbone data model with a file on the O/S

Probe parameters are listed under SyncProbe.




  • modelId
  • callback

Get the full path to the file

This builds the full pathname to the file, and performs an fs.sync() on that pathname, providing the pathname and sync object in the callback.


  • modelId String

    ID of the data model to sync

  • callback Function(error, return)
    • error Object

      Error object (null if no error)

    • return Object

      return object

      • path String
        Full pathname to the file
      • stat Fs.stats
        Stats object (null if the file doesn't esixt)


() String static

Get the current root path.

As a static method, this is only available on the server running the probe. For security purposes, this is not exposed in the FileSyncProbe data model.


String: The path to the root directory for the FilePath probe


  • attributes
  • options

Inherited from Probe:

Initialize the probe

This is called on the probe during construction. It contains the probe initialization attributes and an option to make probe construction asynchronous.

Probe implementations can defer the initial response to the monitor until the initial state is loaded. This allows the callback on Monitor.connect() to have the complete initial state of the probe when called.

If the initial probe state cannot be determined in initialize, it should set the options.asyncInit option to true, and call the options.callback(error) once the initial state is determined.

// Asynchronous initialization
options.asyncInit = true;
var callback = options.callback

If asyncInit is set to true, the callback must be called once the initial state of the probe is known (or in an error condition).

// Set the initial state, and call the callback

See the initialize method of the FileProbe probe for an example. It defers returning the probe to the monitor until the initial file contents are loaded.


  • attributes Object

    Initial probe attributes sent in from the Monitor

  • options Object

    Initialization options

    • asyncInit Boolean

      Set this to TRUE if the initial probe state can't be known immediately.

    • callback Function(error)

      The callback to call if asyncInit is set to true. If an error is passed, the probe will not be used.


  • name
  • [params]
  • [callback]

Inherited from Probe:

Dispatch a control message to the appropriate control function.

This is called when the control() method of a monitor is called. The name determines the method name called on the probe.

The probe must implement a method with the name {name}_control(), and that method must accept two parameters - an input params and a callback. The callback must be called, passing an optional error and response object.

For example, if the probe supports a control with the name go, then all it needs to do is implement the go_control() method with the proper signature. See ping_control() for an example.


  • name String

    Name of the control message.

  • [params] Any optional

    Input parameters specific to the control message.

  • [callback] Function(error, response) optional

    Called to send the message (or error) response.

    • error (Any) An object describing an error (null if no errors)
    • response (Any) Response parameters specific to the control message.


  • params
  • callback

Inherited from Probe:

Respond to a ping control sent from a monitor


  • params Object

    Input parameters (not used)

  • callback Function(error, response)

    Called to send the message (or error) response.

    • error (Any) An object describing an error
    • response (String) The string 'pong' is returned as the response



Inherited from Probe:

Release any resources consumed by this probe.

This can be implemented by derived classes that need to be informed when they are to be shut down.

Probes that listen to events should use this method to remove their event listeners.


  • rootPath

Set the server root path for objects stored with this probe

For security purposes, this must be set before the SyncFileProbe will operate. It will not accept any changes once set.


  • rootPath String

    A path to the root directory for model object storage