diff options
Diffstat (limited to '')
| -rw-r--r-- | src/xml_server.erl | 47 |
1 files changed, 22 insertions, 25 deletions
diff --git a/src/xml_server.erl b/src/xml_server.erl index eee4771..4eef4c9 100644 --- a/src/xml_server.erl +++ b/src/xml_server.erl @@ -7,40 +7,37 @@ %%% == Protocol == %%% %%% Client sends commands as line-delimited strings: -%%% -%%% ``` -%%% QUERY <erlang-term-string> - Execute a query plan, returns session ID -%%% NEXT <session-id> <count> - Get next N tuples from iterator -%%% CLOSE <session-id> - Close iterator and free resources -%%% ``` +%%% <pre> +%%% QUERY <erlang-term-string> - Execute a query plan, returns session ID +%%% NEXT <session-id> <count> - Get next N tuples from iterator +%%% CLOSE <session-id> - Close iterator and free resources +%%% </pre> %%% %%% Server responds with XML: -%%% -%%% ``` -%%% <?xml version="1.0"?> -%%% <response> -%%% <session>abc123</session> -%%% <tuples> -%%% <tuple> -%%% <attribute name="id">1</attribute> -%%% <attribute name="name">Alice</attribute> -%%% </tuple> -%%% </tuples> -%%% </response> -%%% ``` +%%% <pre> +%%% <?xml version="1.0"?> +%%% <response> +%%% <session>abc123</session> +%%% <tuples> +%%% <tuple> +%%% <attribute name="id">1</attribute> +%%% <attribute name="name">Alice</attribute> +%%% </tuple> +%%% </tuples> +%%% </response> +%%% </pre> %%% %%% == Usage == -%%% -%%% ``` +%%% <pre> %%% % Start server on port 8080 %%% xml_server:start(8080). %%% %%% % Client connects and sends: %%% % QUERY {scan, employees}\n -%%% % NEXT <session-id> 10\n -%%% % NEXT <session-id> 10\n -%%% % CLOSE <session-id>\n -%%% ``` +%%% % NEXT <session-id> 10\n +%%% % NEXT <session-id> 10\n +%%% % CLOSE <session-id>\n +%%% </pre> %%% %%% @author Nekoma Team %%% @copyright 2025 |
