diff --git a/ballerina/Package.md b/ballerina/Package.md deleted file mode 100644 index 15604a4e..00000000 --- a/ballerina/Package.md +++ /dev/null @@ -1,100 +0,0 @@ -## Package overview - -This package provides APIs to schedule a Ballerina job either once or periodically and to manage the execution of those jobs. - -### Jobs and scheduling - -Every scheduling job in Ballerina needs to be represented by a `Job` object. Therefore, a `job` class with your custom logic needs to be created to execute it when the task is triggered. - -The `task` package has the following two scheduling systems to schedule the job: - -- One-time job execution -- Frequency-based job execution - -#### One-time job execution - -This API provides the functionality to schedule a job at a specified time. - -The following code snippet shows how to schedule a one-time job. - -```ballerina -class Job { - - *task:Job; - string msg; - - public function execute() { - io:println(self.msg); - } - - isolated function init(string msg) { - self.msg = msg; - } -} - -time:ZoneOffset zoneOffset = { - hours: 5, - minutes: 30, - seconds: 0.0 -}; -time:Civil time = { - year: 2021, - month: 4, - day: 13, - hour: 4, - minute: 50, - second: 50.52, - timeAbbrev: "Asia/Colombo", - utcOffset: zoneOffset -}; - -task:JobId result = check task:scheduleOneTimeJob(new Job("Hi"), time); -``` - -##### Frequency-based job execution - -This API provides the functionality to schedule jobs on a specific interval either once or periodically by configuring the configuration such as start time, end time, and maximum count. - -The following code snippet shows how to schedule a recurring job by using this API. - -```ballerina -class Job { - - *task:Job; - string msg; - - public function execute() { - io:println(self.msg); - } - - isolated function init(string msg) { - self.msg = msg; - } -} - -time:ZoneOffset zoneOffset = { - hours: 5, - minutes: 30 -}; -time:Civil time = { - year: 2021, - month: 3, - day: 31, - hour: 4, - minute: 50, - second: 50.52, - timeAbbrev: "Asia/Colombo", - utcOffset: zoneOffset -}; - -task:JobId result = check task:scheduleJobRecurByFrequency(new Job("Hi"), 2.5, maxCount = 10, startTime = time); -``` - -## Report issues - -To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina standard library parent repository](https://github.com/ballerina-platform/ballerina-standard-library). - -## Useful links - -- Chat live with us via our [Discord server](https://discord.gg/ballerinalang). -- Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag. diff --git a/ballerina/Module.md b/ballerina/README.md similarity index 100% rename from ballerina/Module.md rename to ballerina/README.md