Packages

shackle

0.6.12
0.7.3 0.7.2 0.7.1 0.7.0 0.6.15 0.6.12 0.6.11 0.6.10 0.5.4 0.5.1 0.5.0 0.4.3 0.4.2 0.3.2 0.3.1

High-Performance Erlang Network Client Framework

HexDocs

Current section

Files

Jump to
Readme
15 Versions
3 Dependencies
5 Dependants
Files
Activity
shackle src shackle_client.erl
Raw

src/shackle_client.erl 

-module(shackle_client).

-include("shackle_internal.hrl").



-optional_callbacks([handle_timeout/2]).



-callback init(Options :: term()) ->

    {ok, State :: term()} |

    {error, Reason :: term()}.



-callback setup(Socket :: inet:socket(), State :: term()) ->

    {ok, State :: term()} |

    {error, Reason :: term(), State :: term()}.



-callback handle_request(Request :: term(), State :: term()) ->

    {ok, RequestId :: external_request_id(), Data :: iodata(), State :: term()}.



-callback handle_data(Data :: binary(), State :: term()) ->

    {ok, [Response :: response()], State :: term()} |

    {error,  Reason :: term(), State :: term()}.



-callback handle_timeout(RequestId :: external_request_id(), State :: term()) ->

    {ok, Response :: response(), State :: term()} |

    {error,  Reason :: term(), State :: term()}.



-callback terminate(State :: term()) ->

    ok.