Yesod.JobQueue

Background jobs library for Yesod. Use example is in README.md.

Documentation

class (Yesod master, Read (JobType master), Show (JobType master), Generic (JobType master), Constructors (Rep (JobType master))) => YesodJobQueue master where

Backend jobs for Yesod

Minimal complete definition

runJob, runDBJob, getJobState

Associated Types

type JobType master

Custom Job Type

Methods

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

Job Handler

queueConnectInfo :: master -> ConnectInfo

connection info for redis

queueKey :: master -> ByteString

queue key name for redis

threadNumber :: master -> Int

The number of threads to run the job

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

runDB for job

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)

describeJob :: master -> JobTypeString -> Maybe Text

Job Information

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

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

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

Add job to end of the queue

type JobState = TVar [RunningJob]

Manage the running jobs

newJobState :: IO (TVar [RunningJob])

create new JobState

jobQueueInfo :: YesodJobQueue master => master -> JobQueueClassInfo

Need by getClassInformation

getJobQueue :: a -> JobQueue