Module riak_api_pb_listener

Description
Function Index
Function Details

entry point for TCP-based protocol buffers service.

Behaviours: gen_nb_server.

Description

entry point for TCP-based protocol buffers service

Function Index

code_change/3	The gen_server code_change/3 callback, called when performing a hot code upgrade on the server.
get_listeners/0
handle_call/3	The handle_call/3 gen_nb_server callback.
handle_cast/2	The handle_cast/2 gen_nb_server callback.
handle_info/2	The handle_info/2 gen_nb_server callback.
init/1	Initialization callback for gen_nb_server.
new_connection/2	The connection initiation callback for gen_nb_server, called when a new socket is accepted.
sock_opts/0	Preferred socket options for the listener.
start_link/2	Starts the PB listener.
terminate/2	The code_change/3 gen_nb_server callback.

Function Details

code_change/3

code_change(OldVsn, State, Extra) -> {ok, State} | {error, Reason}

OldVsn = Vsn | {down, Vsn}
Vsn = term()
State = #state{}
Extra = term()
Reason = term()

The gen_server code_change/3 callback, called when performing a hot code upgrade on the server. Currently unused.

get_listeners/0

get_listeners() -> any()

handle_call/3

handle_call(Req::term(), From::{pid(), term()}, State::#state{}) -> {reply, term(), #state{}}

The handle_call/3 gen_nb_server callback. Unused.

handle_cast/2

handle_cast(Msg::term(), State::#state{}) -> {noreply, #state{}}

The handle_cast/2 gen_nb_server callback. Unused.

handle_info/2

handle_info(Info::term(), State::#state{}) -> {noreply, #state{}}

The handle_info/2 gen_nb_server callback. Unused.

init/1

init(X1::list()) -> {ok, #state{}}

Initialization callback for gen_nb_server.

new_connection/2

new_connection(Socket::port(), State::#state{}) -> {ok, #state{}}

The connection initiation callback for gen_nb_server, called when a new socket is accepted.

sock_opts/0

sock_opts() -> [gen_tcp:option()]

Preferred socket options for the listener.

start_link/2

start_link(IpAddr::inet:ip_address() | string(), PortNum::non_neg_integer()) -> {ok, pid()} | {error, term()}

Starts the PB listener

terminate/2

terminate(Reason, State) -> ok

Reason = normal | shutdown | {shutdown, term()} | term()
State = #state{}

The code_change/3 gen_nb_server callback. Unused.

Generated by EDoc