phaser-server  0.0.5
Public Member Functions | Protected Member Functions | List of all members
PauseNotice Class Reference

Job pause/resume notice. More...

#include <notify.h>

Inheritance diagram for PauseNotice:
Inheritance graph
[legend]
Collaboration diagram for PauseNotice:
Collaboration graph
[legend]

Public Member Functions

 PauseNotice (const PhaseJob *job)
 
- Public Member Functions inherited from JsonNotice
 JsonNotice (const char *value)
 Initialize the value of the 'notification' tag.
 
std::string operator() (void)
 Get the JSON encoded response string.
 

Protected Member Functions

virtual void Create (JSONObject &) override
 Add job pause state information as "paused". More...
 
- Protected Member Functions inherited from JobNotice
 JobNotice (const char *value, const PhaseJob *job)
 Initialize value of 'notification' tag and the RF phasing job.
 
void AddDate (JSONObject &, const char *, time_t)
 Add date information to the passed JSON object. More...
 

Additional Inherited Members

- Protected Attributes inherited from JobNotice
const PhaseJobm_job
 Job whose status is to be reported.
 

Detailed Description

Job pause/resume notice.

Note
A copy of the passed job is not made, it must stay in scope for the lifetime of the object.

Constructor & Destructor Documentation

◆ PauseNotice()

PauseNotice::PauseNotice ( const PhaseJob job)
inline

Construct an instance.

Parameters
job- The currently executing job.

Member Function Documentation

◆ Create()

void PauseNotice::Create ( JSONObject &  root)
overrideprotectedvirtual

Add job pause state information as "paused".

Parameters
root- JSON object to be updated.

Implements JsonNotice.


The documentation for this class was generated from the following files: