View Source Grizzly.Transport behaviour (grizzly v1.0.1)
Behaviour and functions for communicating to zipgateway
Link to this section Summary
Types
After starting a server options can be passed back to the caller so that the caller can do any other work it might seem fit.
Functions
Accept a new connection
Get the assign value for the field
Update the assigns with this field and value
Preform the handshake
Listen using a transport
Make a new Grizzly.Transport
Open the transport
Parse the response for the transport
Send binary data using a transport
Link to this section Types
Specs
args() :: [ ip_address: :inet.ip_address(), port: :inet.port_number(), transport: t() ]
Specs
listen_option() :: {:strategy, :none | :accept}
After starting a server options can be passed back to the caller so that the caller can do any other work it might seem fit.
Options:
:strategy
- this informs the caller if the transport needs to wait for connects to accept or if the socket can just process incoming messages. If the strategy is:accept
that is to mean the socket is okay to start accepting new connections.
Specs
parse_opt() :: {:raw, boolean()}
Specs
socket() :: :ssl.sslsocket() | :inet.socket()
Specs
t()
Link to this section Callbacks
Specs
Specs
close(t()) :: :ok
Specs
Specs
listen(t()) :: {:ok, t(), [listen_option()]} | {:error, any()}
Specs
Specs
parse_response(any(), [parse_opt()]) :: {:ok, Grizzly.Transport.Response.t() | binary() | :connection_closed} | {:error, Grizzly.ZWave.DecodeError.t()}
Specs
Link to this section Functions
Specs
Accept a new connection
Specs
Get the assign value for the field
Specs
Update the assigns with this field and value
Specs
Preform the handshake
Specs
listen(t()) :: {:ok, t(), [listen_option()]} | {:error, any()}
Listen using a transport
Specs
Make a new Grizzly.Transport
If need to optionally assign some priv data you can map that into this function.
Specs
Open the transport
Parse the response for the transport
Specs
Send binary data using a transport