{"result":{"depiction_url":null,"edges":{"subject":{"objects":[{"created":"2026-09-30T09:11:23Z","object_id":{"id":2555,"is_a":["categorization","keyword","keyword_information_type"],"name":"zotonic_topic_reference","title":"Reference","uri":"https:\/\/zotonic.com\/id\/2555"},"seq":1},{"created":"2026-09-30T09:11:23Z","object_id":{"id":2563,"is_a":["categorization","keyword","keyword_audience"],"name":"zotonic_topic_frontend_developer","title":"Frontend developer","uri":"https:\/\/zotonic.com\/id\/2563"},"seq":2},{"created":"2026-09-30T09:11:23Z","object_id":{"id":2655,"is_a":["categorization","keyword","keyword_task"],"name":"zotonic_topic_publish_and_subscribe","title":"Publish and subscribe","uri":"https:\/\/zotonic.com\/id\/2655"},"seq":3},{"created":"2026-09-30T09:11:23Z","object_id":{"id":2673,"is_a":["categorization","keyword","keyword_technology"],"name":"zotonic_topic_javascript","title":"JavaScript","uri":"https:\/\/zotonic.com\/id\/2673"},"seq":4},{"created":"2026-09-30T09:11:23Z","object_id":{"id":2718,"is_a":["categorization","keyword","keyword_technology"],"name":"zotonic_topic_cotonic","title":"Cotonic","uri":"https:\/\/zotonic.com\/id\/2718"},"seq":5},{"created":"2026-09-30T09:11:23Z","object_id":{"id":2719,"is_a":["categorization","keyword","keyword_technology"],"name":"zotonic_topic_web_workers","title":"Web Workers","uri":"https:\/\/zotonic.com\/id\/2719"},"seq":6}],"predicate":{"id":308,"is_a":["meta","predicate"],"name":"subject","title":{"_type":"trans","tr":{"en":"Keyword"}},"uri":"http:\/\/purl.org\/dc\/elements\/1.1\/subject"}}},"id":2732,"is_a":["text","documentation","reference","cotonic_reference"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2732"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_cotonic_worker_functions","page_url":{"en":"https:\/\/zotonic.com\/cotonic\/worker_functions","x-default":"https:\/\/zotonic.com\/cotonic\/worker_functions"},"preview_url":null,"resource":{"version":16,"pivot_location_lat":null,"title":"Worker functions","is_authoritative":true,"body":"<\/a>\n

\n Workers are stand alone processes. They have no shared data with the page, nor\n with other workers. Their memory and calling context is isolated. They can easily communicate\n with other workers, the page, and servers by publising messages on topics, and subscribing\n to them. Cotonic provides models<\/a>, modules which are loaded and\n ready for requests.\n <\/p>\n\n \n <\/a>

on_init self.on_init(arguments)<\/code><\/h2>

\n The callback on_init<\/tt> is called when the worker receives the initialization\n message by the page. It can take multiple arguments. The arguments are passed in via\n the spawn<\/tt><\/a> args<\/tt> argument list.\n This function can be used to initialize the worker. The callback is optional.\n <\/p>\n 

\n\/\/ Page code.\ncotonic.spawn("example_worker", [amount, target]);\n\n\/\/ Worker code\n\nlet amount = null;\nlet targetId = null;\n\nself.on_init = function(n, id) {\n    amount = n;\n    targetId = id;\n}\n==> Worker receives the arguments which can be used for initialization.<\/pre>\n\n            \n            <\/a>
connect self.connect(connectOptions)<\/code><\/h2>
\n            Connect the worker to the page. Returns a promise. This promise is resolved when\n            the worker is connected to the page. When is indicated in the connectOptions<\/tt> that\n            the worker depends on other services the promise is resolved after those dependencies\n            have become available.\n\n            Parameter connectOptions<\/tt> supports the following options:\n            <\/p>\n            
\n                
name<\/tt><\/dt>\n                
The name of the worker.<\/dd>\n\n                
depends<\/tt><\/dt>\n                
A list of dependencies on which the worker needs. The connect promise will be\n                resolved, after the dependencies become available.<\/dd>\n\n                
provides<\/tt><\/dt>\n                
A list of dependencies which is provided by this worker. The are published after\n                the worker is connected.<\/dd>\n            <\/dl>\n            
\nself.connect().then(\n    function() {\n        console.log("Connected");\n    }\n);\n=> The worker is being connected to the page.<\/pre>\n            
\nself.connect({depends: ["model\/ui",\n                        "model\/serviceWorker",\n                        "worker\/abc"]}).then(\n    function() {\n        console.log("Connected, the requested dependencies are available, and worker abc is started.");\n    }\n);\n=> The worker is being connected to the page, and the requested dependencies are available.<\/pre>\n\n\n            \n            <\/a>
disconnect self.disconnect()<\/code><\/h2>
\n            Disconnects the worker from the page. After this step it is no\n            longer possible to send and receive messages from the page.\n            <\/p>\n            
\nself.disconnect();\n=> The worker is disconnected from the page.<\/pre>\n\n            \n            <\/a>
is_connected self.is_connected()<\/code><\/h2>
\n            Returns true<\/tt> iff the worker is connected to the page,\n            false<\/tt> otherwise.\n            <\/p>\n            
\nself.is_connected();\n=> true<\/pre>\n\n            \n            <\/a>
whenDependencyProvided self.whenDependencyProvided(dependency)<\/code><\/h2>
\n            Returns a Promise which is resolved when the external dependency is provided.\n            <\/p>\n            
\nself.whenDependencyProvided("model\/ui").then(\n    function() {\n        worker.publish("model\/ui\/insert\/foo", {..});\n    });\n<\/pre>\n            \n            <\/a>
whenDependenciesProvided self.whenDependenciesProvided(dependencies)<\/code><\/h2>
\n            Returns a Promise which is resolved when all external dependencies are provided.\n            <\/p>\n            
\nself.whenDependenciesProvided(["model\/ui", "model\/x"]).then(\n    function() {\n        ...\n    });\n==> The promise will be resolved after the ui and x model are provided.<\/pre>\n\n            \n            <\/a>
provides self.provides(modelsAndWorkers)<\/code><\/h2>
\n            Indicate to other workers and the page that this worker provides models or workers.\n            Other workers waiting on these dependencies will get notified when they become\n            available. The parameter modelsAndWorkers<\/tt> should be a list with model or\n            worker names this worker provides.\n            <\/p>\n            
\nself.provides(["model\/a", "model\/b", "worker\/x"])\n==> When the worker connects, it will notify other workers that new models\n    have become available.<\/pre>\n\n\n            \n            <\/a>
subscribe self.subscribe(topics, callback, ack_callback)<\/code><\/h2>
\n            Subscribe the worker to the topics<\/tt>. When a message is received, the callback<\/tt> is called.\n            Callback is a function which receives two parameters. The first parameter is the message<\/tt>, the second\n            parameter an object<\/tt> returned by extract<\/a>. This can be used to\n            easily extract elements from topic paths in an object. The parameter topics<\/tt> can be a string, or\n            a list of strings. The callback ack_callback<\/tt> is used when the page is subscribed, or when\n            there is a problem. Returns nothing.\n            <\/p>\n            
\nfunction logSpeed(msg, args) {\n    if(args.boat_id) {\n        console.log("boat", args.boat_id, "is now moving at", msg.payload);\n    }\n    if(args.truck_id) {\n        console.log("truck", args.truck_id, "is now moving at", msg.payload);\n    }\n}\nself.subscribe(["truck\/+boat_id\/speed", "boat\/+boat_id\/speed"], logSpeed);\n=> The function logSpeed will be called when somebody sends a message which\n   matches the topics.<\/pre>\n\n            \n            <\/a>
unsubscribe self.unsubscribe(topics, callback, ack_callback)<\/code><\/h2>
\n            Unsubscribe the worker from page. The worker will no longer receive messages from the specified topics.\n            <\/p>\n            
\nself.unsubscribe();<\/pre>\n\n            \n            <\/a>
publish self.publish(topic, message, options)<\/code><\/h2>
\n            Publish message<\/tt> on topic<\/tt>. The options<\/tt> can be used to indicate\n            the quality of service, or if the message should be retained by the broker.\n            <\/p>\n            
\nself.publish("world", "hello", {retain: true});<\/pre>\n\n            \n            <\/a>
call self.call(topic, message, options)<\/code><\/h2>
\n            Publishes message<\/tt> on topic<\/tt> and subscribes itself to a reply topic.\n            Returns a promise which is fulfilled when a message is received on the reply topic. When\n            no message arrives, the promise is rejected. Returns a promise.\n            <\/p>\n            
\nself.call("model\/document\/get\/all")\n.then(...)\n.reject(...);<\/pre>\n\n           ","slug":"worker-functions","is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"43bec4c72069474bb1e6354404d5ea798c1fce935d272c57f46ae9f152c59e40","is_featured":false,"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"category_id":{"id":2722,"is_a":["meta","category"],"name":"cotonic_reference","title":"Cotonic","uri":"https:\/\/zotonic.com\/id\/cotonic_reference"},"doc_source_path":"index.html","publication_start":"2026-09-30T09:11:23Z","page_path":"\/cotonic\/worker_functions","github_url":"https:\/\/github.com\/cotonic\/cotonic\/blob\/master\/index.html","pivot_location_lng":null,"doc_source_kind":"cotonic","name":"doc_cotonic_worker_functions","is_unfindable":false,"is_published":true,"pivot_geocode":null,"created":"2026-09-30T09:11:23Z","uri":null,"doc_source_anchor":"worker.functions","doc_status":"current","is_dependent":false,"publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"f88cc928b997d10f7f19e6bd0ede80e1c8c619bc","creator_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"modified":"2026-09-30T10:06:59Z","title_slug":"worker-functions"},"uri":"https:\/\/zotonic.com\/id\/2732","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2732"}},"status":"ok"}