Module riak_api_pb_server

Service protocol buffer clients.

Behaviours: gen_fsm.

Description

Service protocol buffer clients. This module implements only the TCP socket management and dispatch of incoming messages to service modules.

Data Types

format()

format() = {format, term()} | {format, io:format(), [term()]}

Function Index

code_change/4The gen_server code_change/3 callback, called when performing a hot code upgrade on the server.
connected/2
connected/3
handle_event/3The handle_event/3 gen_fsm callback.
handle_info/3The handle_info/3 gen_fsm callback.
handle_sync_event/4
init/1The gen_server init/1 callback, initializes the riak_api_pb_server.
service_registered/2Notifies the server process of a newly registered PB service.
set_socket/2Sets the socket to service for this server.
start_link/0Starts a PB server, ready to service a single socket.
terminate/3The gen_server terminate/2 callback, called when shutting down the server.
wait_for_auth/2
wait_for_auth/3
wait_for_socket/2
wait_for_socket/3
wait_for_tls/2
wait_for_tls/3

Function Details

code_change/4

code_change(OldVsn, StateName, State, Extra) -> {ok, StateName, State}

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

connected/2

connected(Event, State) -> any()

connected/3

connected(Event, From, State) -> any()

handle_event/3

handle_event(Msg, StateName, State) -> any()

The handle_event/3 gen_fsm callback.

handle_info/3

handle_info(StreamMessage, SN, State) -> any()

The handle_info/3 gen_fsm callback.

handle_sync_event/4

handle_sync_event(Event, From, StateName, State) -> any()

init/1

init(X1::list()) -> {ok, wait_for_socket, #state{transport = {gen_tcp, inet} | {ssl, ssl}, socket = port() | ssl:sslsocket(), req = any(), states = orddict:orddict(), peername = undefined | {inet:ip_address(), pos_integer()}, common_name = undefined | string(), security = any(), retries = any(), inbuffer = any(), outbuffer = riak_api_pb_frame:buffer()}}

The gen_server init/1 callback, initializes the riak_api_pb_server.

service_registered/2

service_registered(Pid::pid(), Mod::module()) -> ok

Notifies the server process of a newly registered PB service.

set_socket/2

set_socket(Pid::pid(), Socket::port()) -> ok

Sets the socket to service for this server.

start_link/0

start_link() -> {ok, pid()} | {error, term()}

Starts a PB server, ready to service a single socket.

terminate/3

terminate(Reason, StateName, State) -> ok

The gen_server terminate/2 callback, called when shutting down the server.

wait_for_auth/2

wait_for_auth(Event, State) -> any()

wait_for_auth/3

wait_for_auth(Event, From, State) -> any()

wait_for_socket/2

wait_for_socket(Event, State) -> any()

wait_for_socket/3

wait_for_socket(Event, From, State) -> any()

wait_for_tls/2

wait_for_tls(Event, State) -> any()

wait_for_tls/3

wait_for_tls(Event, From, State) -> any()


Generated by EDoc