Module backwater

Data Types
Function Index
Function Details

References

ranch:opt() documentation
ranch_tcp:opt() documentation
ranch_ssl:opt() documentation
cowboy_http:opts() documentation
hackney request options listed here

Data Types

call_opts()

call_opts() = #{hackney_opts => [hackney_option()], compression_threshold => non_neg_integer(), connect_timeout => timeout(), decode_unsafe_terms => boolean(), max_encoded_result_size => non_neg_integer(), recv_timeout => timeout(), rethrow_remote_exceptions => boolean()}

call_result()

call_result() = backwater_response:t(hackney_error())

clear_opt()

clear_opt() = ranch:opt() | ranch_tcp:opt()

clear_opts()

clear_opts() = [clear_opt()]

hackney_error()

hackney_error() = {hackney, term()}

hackney_option()

hackney_option() = proplists:property()

http_opts()

http_opts() = cowboy_http:opts()

tls_opt()

tls_opt() = ranch:opt() | ranch_ssl:opt()

tls_opts()

tls_opts() = [tls_opt()]

Function Index

call/4	Performs remote call on `Endpoint`.
call/5	Performs remote call on `Endpoint`.
start_clear_server/2	Starts a cleartext cowboy listener that can handle remote calls.
start_clear_server/4	Like `:start_clear_server/2` but one can specify the listener name and tune settings.
start_tls_server/3	Starts a TLS cowboy listener that can handle remote calls.
start_tls_server/4	Like `:start_tls_server/3` but one can specify the listener name and tune (more) settings.
stop_server/0	Stops the cowboy listener under the default name.
stop_server/1	Stops the cowboy listener under a specific name.

Function Details

call/4

call(Endpoint, Module, Function, Args) -> Result | no_return()

Endpoint = backwater_request:endpoint()
Module = module()
Function = atom()
Args = [term()]
Result = call_result()

Performs remote call on Endpoint.

Returns:

{ok, ReturnValue} in case of success
{error, term()} otherwise.

See also: call/5.

call/5

call(Endpoint, Module, Function, Args, Options) -> Result | no_return()

Endpoint = backwater_request:endpoint()
Module = module()
Function = atom()
Args = [term()]
Options = call_opts()
Result = call_result()

Performs remote call on Endpoint.

Returns:

{ok, ReturnValue} in case of success
{error, term()} otherwise.

See also: call/4.

start_clear_server/2

start_clear_server(Secret, ExposedModules) -> {ok, pid()} | {error, term()}

Secret = binary()
ExposedModules = [backwater_module_exposure:t()]

Starts a cleartext cowboy listener that can handle remote calls.

Returns:

{ok, ServerPid} in case of success
{error, term()} otherwise.

See also: start_clear_server/4.

start_clear_server/4

start_clear_server(Ref, Secret, ExposedModules, Opts) -> {ok, pid()} | {error, term()}

Ref = term()
Secret = binary()
ExposedModules = [backwater_module_exposure:t()]
Opts = backwater_cowboy_handler:opts(clear_opts(), http_opts())

Like :start_clear_server/2 but one can specify the listener name and tune settings.

Returns:

{ok, ServerPid} in case of success
{error, term()} otherwise.

See also: start_clear_server/2.

start_tls_server/3

start_tls_server(Secret, ExposedModules, TLSOpts) -> {ok, pid()} | {error, term()}

Secret = binary()
ExposedModules = [backwater_module_exposure:t()]
TLSOpts = tls_opts()

Starts a TLS cowboy listener that can handle remote calls.

Returns:

{ok, ServerPid} in case of success
{error, term()} otherwise.

See also: start_tls_server/4.

start_tls_server/4

start_tls_server(Ref, Secret, ExposedModules, Opts) -> {ok, pid()} | {error, term()}

Ref = term()
Secret = binary()
ExposedModules = [backwater_module_exposure:t()]
Opts = backwater_cowboy_handler:opts(tls_opts(), http_opts())

Like :start_tls_server/3 but one can specify the listener name and tune (more) settings.

Returns:

{ok, ServerPid} in case of success
{error, term()} otherwise.

See also: start_tls_server/3.

stop_server/0

stop_server() -> ok | {error, not_found}

Stops the cowboy listener under the default name.

stop_server/1

stop_server(Ref) -> ok | {error, not_found}

Ref = term()

Stops the cowboy listener under a specific name.

Generated by EDoc