{"id":17056818,"url":"https://github.com/halturin/erlang-llsn","last_synced_at":"2025-08-12T01:21:14.687Z","repository":{"id":35562128,"uuid":"39834022","full_name":"halturin/erlang-llsn","owner":"halturin","description":"Erlang support for LLSN (binary format)","archived":false,"fork":false,"pushed_at":"2017-06-07T10:01:30.000Z","size":442,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T11:51:10.523Z","etag":null,"topics":["binaryformat","erlang","library","llsn"],"latest_commit_sha":null,"homepage":"","language":"Erlang","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/halturin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-28T12:58:52.000Z","updated_at":"2021-07-29T12:47:21.000Z","dependencies_parsed_at":"2022-08-31T22:00:44.151Z","dependency_job_id":null,"html_url":"https://github.com/halturin/erlang-llsn","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halturin%2Ferlang-llsn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halturin%2Ferlang-llsn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halturin%2Ferlang-llsn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/halturin%2Ferlang-llsn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/halturin","download_url":"https://codeload.github.com/halturin/erlang-llsn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248605107,"owners_count":21132112,"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":["binaryformat","erlang","library","llsn"],"created_at":"2024-10-14T10:25:41.753Z","updated_at":"2025-04-12T17:33:55.843Z","avatar_url":"https://github.com/halturin.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"erlang-LLSN\n======\n\n[![GitHub version](https://badge.fury.io/gh/allyst%2Ferlang-llsn.svg)](https://github.com/allyst/erlang-llsn/releases)\n\nThis is Erlang implementation of LLSN binary format.\nHere is specifiaction: http://allyst.org/opensource/llsn/\n\nBasics\n------\n...\n\n```Erlang\n   Struct = {?LLSN_TYPE_NUMBER, ?LLSN_TYPE_STRING},\n   Packet = {12345, \"Hello World!\"},\n   Bin = llsn:encode(Packet, Struct).\n```\n\n...\n\n```Erlang\n   Struct = {\n             ?LLSN_TYPE_NUMBER, ?LLSN_TYPE_STRING, \n             {?LLSN_TYPE_ARRAY, ?LLSN_TYPE_NUMBER}\n            },\n   Packet = {12345, \"Hello World!\", [1,2,3,4,5]},\n   Bin = llsn:encode(Packet, Struct).\n```\n\n...\n\n```Erlang\n   Struct = {\n             ?LLSN_TYPE_NUMBER, ?LLSN_TYPE_STRING,\n             {?LLSN_TYPE_ARRAYN, ?LLSN_TYPE_NUMBER}\n            },\n   Packet = {12345, \"Hello World!\", [1,2,null,null,5]},\n   Bin = llsn:encode(Packet, Struct).\n```\n\n...\n\n```Erlang\n   Struct = {\n             ?LLSN_TYPE_NUMBER, ?LLSN_TYPE_STRING,\n             {?LLSN_TYPE_ARRAYN, ?LLSN_TYPE_NUMBER},\n             {?LLSN_TYPE_STRUCT,[?LLSN_TYPE_BOOL, ?LLSN_TYPE_DATE]}\n            },\n   Packet = {\n             12345, \"Hello World!\",\n             [1,2,null,null,5],\n             {false, {{2015, 4, 15},{16, 56, 39, 678},{0,0}}}\n            },\n   Bin = llsn:encode(Packet, Struct).\n```\n\nExtended features of data encoding\n-----------------------\n#### Tree-like data\n...\n\nC-example of tree like data structure\n\n```C\ntypedef TreeStruct struct {\n    int value,\n    TreeStruct *child\n}\n```\n\nIn LLSN you have to use  LLSN_TYPE_POINTER. \n\n```Erlang\n   Struct = {\n             ?LLSN_TYPE_NUMBER, ?LLSN_TYPE_STRING,\n             {?LLSN_TYPE_ARRAYN, ?LLSN_TYPE_NUMBER},\n             {?LLSN_TYPE_STRUCT,[?LLSN_TYPE_BOOL, ?LLSN_TYPE_DATE]},\n             {?LLSN_TYPE_STRUCT,[?LLSN_TYPE_NUMBER, {?LLSN_TYPE_POINTER,[3]}]}\n            },\n   Packet = {\n             12345, \"Hello World!\",\n             [1,2,null,null,5],\n             {false, {{2015, 4, 15},{16, 56, 39, 678},{0,0}},\n             {1,{2,{3,null}}}}\n            },\n   Bin = llsn:encode(Packet, Struct).\n```\n\n\n#### Data framing\n\n...\n\n```Erlang\n   Bin = llsn:encode(Packet, Struct, self()).\n```\n\nDefault frame size has value 49152 bytes (as LLSN_DEFAULT_FRAME_LIMIT definition in .erl file). You\ncan specify custom value\n\n```Erlang\n   Bin = llsn:encode(Packet, Struct, self(), 128000).\n```\n\n... 3th argument is Pid of receiver process.\n\n```Erlang\nreceive_frame(Bin) -\u003e\n    receive\n        {frame, _N, _Size, Frame, UserData } -\u003e\n            ?assert(UserData =:= [userdata]),\n            receive_frame(\u003c\u003cBin/binary,Frame/binary\u003e\u003e);\n\n        {done, _N, _Size, Frame, UserData} -\u003e\n            ?assert(UserData =:= [userdata]),\n            \u003c\u003cBin/binary,Frame/binary\u003e\u003e\n\n    after 1000 -\u003e ?assert(\"timeout\")\n    end.\n\n...\n\ndemoframe() -\u003e\n...\n    ok  = llsn:encode(Packet, Struct, self(), 50, [userdata]),\n    Bin  = receive_frame(\u003c\u003c\u003e\u003e),\n```\n\n#### Decode partitioned data\n\nIt's able to decode part of encoded data starting from the first frame.\n\n```Erlang\n    case decode(Bin) of\n        {parted, State1} -\u003e\n            % part of the packet\n            ...\n        Packet -\u003e\n            % complete packet\n            ...\n    end\n    ...\n```\n\nTo continue decoding you have to use State1 and the next part of binary data\n\n```Erlang\n    Value = decode(continue, State1, NextFrame)\n```\n\nIt's useful in case of transfer big files. For example: array of Images.\n\nLicense\n--------\n\nThe MIT License (MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalturin%2Ferlang-llsn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhalturin%2Ferlang-llsn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalturin%2Ferlang-llsn/lists"}