{"id":21040965,"url":"https://github.com/chfoo/zigcall","last_synced_at":"2026-03-19T18:34:34.146Z","repository":{"id":145909927,"uuid":"131763040","full_name":"chfoo/zigcall","owner":"chfoo","description":"Yet another simple Signals and Slots implementation of the observer pattern for the Haxe","archived":false,"fork":false,"pushed_at":"2018-09-05T18:56:49.000Z","size":11,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T12:35:59.383Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Haxe","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chfoo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-01T21:05:21.000Z","updated_at":"2024-12-11T22:45:26.000Z","dependencies_parsed_at":"2024-02-13T07:00:29.102Z","dependency_job_id":null,"html_url":"https://github.com/chfoo/zigcall","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chfoo%2Fzigcall","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chfoo%2Fzigcall/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chfoo%2Fzigcall/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chfoo%2Fzigcall/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chfoo","download_url":"https://codeload.github.com/chfoo/zigcall/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243483157,"owners_count":20297942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T13:49:17.640Z","updated_at":"2026-01-01T22:33:05.163Z","avatar_url":"https://github.com/chfoo.png","language":"Haxe","readme":"ZigCall\n=======\n\nZigCall is, yet another, a simple [Signals and Slots](https://en.wikipedia.org/wiki/Signals_and_slots) implementation of the observer pattern for the Haxe programming language.\n\nZigCall's feature set is intentionally limited when compared to other Haxe signal \u0026 slot libraries. Its goal is to provide a clean and minimal interface to the user.\n\n\nGeneral comparison of event dispatcher to signal and slots:\n\n| Event Dispatcher | Signal and Slots |\n|------------------|------------------|\n| Events | Signals |\n| Listeners | Slots |\n| Dispatch | Emit |\n| Add | Connect |\n| Remove | Disconnect |\n| String event types | Objects for each signal |\n| Dispatcher uses inheritance | Emitter uses composition |\n| Event object | Parameters |\n| Capturing \u0026 bubbling  | None |\n| Cancelling | Typically none |\n\n\nQuick Start\n===========\n\nInstallation\n------------\n\nInstall the library:\n\n        haxelib install zigcall\n\n\nConnecting signals and slots\n----------------------------\n\nIn your class that emits signals, add a `Signal` field for each signal:\n\n```haxe\nimport zigcall.Signal;\n\nclass Keyboard {\n    var _keyDown:Signal;\n    var _keyUp:Signal;\n}\n```\n\nExpose a public version of `Signal` to users:\n\n```haxe\nclass Keyboard {\n    // [...]\n    public var keyDown(default, null):SignalClient;\n    public var keyUp(default, null):SignalClient;\n}\n```\n\nInitialize the fields:\n\n```haxe\nclass Keyboard {\n    // [...]\n    public function new() {\n        keyDown = _keyDown = new Signal();\n        keyUp = _keyUp = new Signal();\n    }\n}\n```\n\nIn your class that contains the slots for processing the signals, connect them:\n\n```haxe\nclass KeyHandler {\n    public function new() {\n        // [...]\n        keyboard.keyDown.connect(keyDownHandler);\n        keyboard.keyUp.connect(keyUpHandler);\n    }\n\n    function keyDownHandler() {\n        trace(\"A key was pressed down.\");\n    }\n\n    function keyUpHandler() {\n        trace(\"A key was released.\");\n    }\n}\n```\n\nEmitting signals\n----------------\n\nSend a signal by calling `emit()`:\n\n```haxe\nclass Keyboard {\n    // [...]\n    public function processKeyEvent() {\n        // [...]\n        _keyDown.emit();\n    }\n}\n```\n\nDisconnecting\n-------------\n\nTo stop receiving signals, call `disconnect()`:\n\n```haxe\nclass KeyHandler {\n    // [...]\n    public function dispose() {\n        keyboard.keyDown.disconnect(keyDownHandler);\n        keyboard.keyUp.disconnect(keyUpHandler);\n    }\n}\n```\n\nParameters\n----------\n\nIf you need to pass data, use the generic version `SignalP`:\n\n```haxe\nimport zigcall;\n\ntypedef ClickedParams = {\n    x:Int,\n    y:Int\n};\n\nclass MouseExample {\n    public static function main() {\n        var clicked = new SignalP\u003cClickedParams\u003e();\n\n        clicked.client.connect(clickedHandler);\n        clicked.emit({ x: 10, y: 15 });\n    }\n\n    static function clickedHandler(params:ClickedParams) {\n        trace('Clicked ${params.x} ${params.y}');\n    }\n}\n```\n\nAnonymous slots\n---------------\n\nIf you have anonymous functions as slots, use the `ConnectionToken` provided when connecting:\n\n```haxe\nclass PingedExample {\n    public static function main() {\n        var pinged = new Signal();\n\n        var token = pinged.client.connect(function () {\n            trace(\"Pinged!\");\n        });\n\n        pinged.emit();\n        token.disconnect();\n    }\n}\n```\n\nIf you need to check whether something is connected, use `isConnected()`:\n\n```haxe\nclass IsConnectedExample {\n    public static function main() {\n        // [...]\n        if (mySignal.isConnected(mySlot)) {\n            // [...]\n        }\n        if (myToken.isConnected()) {\n            // [...]\n        }\n    }\n}\n```\n\nFor details, please check the examples and source code.\nAutomatically generated [API docs](https://chfoo.github.io/zigcall/api/) is also available.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchfoo%2Fzigcall","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchfoo%2Fzigcall","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchfoo%2Fzigcall/lists"}