-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.