Yesod.JobQueue

Documentation

class (Yesod master, Read (JobType master), Show (JobType master), Enum (JobType master), Bounded (JobType master), JobInfo (JobType master)) => YesodJobQueue master where

Minimal complete definition

runJob, runDBJob, getJobState

Associated Types

type JobType master

Methods

runJob :: (MonadBaseControl IO m, MonadIO m) => master -> JobType master -> ReaderT master m ()

queueKey :: master -> ByteString

readJobType :: master -> String -> Maybe (JobType master)

showJobType :: JobType master -> String

allJobTypes :: master -> [JobType master]

runDBJob :: (MonadBaseControl IO m, MonadIO m) => ReaderT (YesodPersistBackend master) (ReaderT master m) a -> ReaderT master m a

startDequeue :: (MonadBaseControl IO m, MonadIO m) => master -> m ()

getJobState :: master -> JobState

get job state

jobAPIBaseUrl :: master -> String

get API and Manager base url

jobManagerJSUrl :: master -> String

get manager application javascript url (change only development)

enqueue :: master -> JobType master -> IO ()

listQueue :: master -> IO (Either String [JobQueueItem])

getClassInformation :: master -> [JobQueueClassInfo]

get information of all type classes related job-queue

data JobQueue

Instances

RenderRoute JobQueue

ParseRoute JobQueue

RouteAttrs JobQueue

Eq (Route JobQueue)

Read (Route JobQueue)

Show (Route JobQueue)

data Route JobQueue

• = JobR
• | JobQueueR
• | JobStateR
• | JobManagerR
• | JobManagerStaticR Text

getJobQueue :: a -> JobQueue

type JobState = TVar [RunningJob]

Manage the running jobs

class JobInfo j where

Minimal complete definition

Nothing

Methods

describe :: j -> String

newJobState :: IO (TVar [RunningJob])

create new JobState