Module libp2p_relay_envelope

Libp2p2 Relay Envelope

Libp2p2 Relay Envelope API.

Data Types

relay_envelope()


relay_envelope() = #libp2p_relay_envelope_pb{}

Function Index

create/1 Create an envelope.
data/1 Getter.
decode/1 Decode relay_envelope binary to record.
encode/1 Encode relay_envelope record to binary.

Function Details

create/1


create(Libp2p_relay_req_pb::libp2p_relay_req:relay_req() | libp2p_relay_resp:relay_resp() | libp2p_relay_bridge:relay_bridge_cr() | libp2p_relay_bridge:relay_bridge_rs() | libp2p_relay_bridge:relay_bridge_sc() | libp2p_relay_ping:relay_ping()) -> relay_envelope()


Create an envelope

data/1


data(Env::relay_envelope()) -> {req, libp2p_relay_req:relay_req()} | {resp, libp2p_relay_resp:relay_resp()} | {bridge_cr, libp2p_relay_bridge:relay_bridge_cr()} | {bridge_rs, libp2p_relay_bridge:relay_bridge_rs()} | {bridge_sc, libp2p_relay_bridge:relay_bridge_sc()} | {ping, libp2p_relay_ping:relay_ping()}


Getter

decode/1


decode(Bin::binary()) -> relay_envelope()


Decode relay_envelope binary to record

encode/1


encode(Libp2p_relay_envelope_pb::relay_envelope()) -> binary()


Encode relay_envelope record to binary