Safe Haskell	None
Language	GHC2021

Network.LibP2P.NAT.Relay.Message

Contents

Types
Status conversion
HopMessage encode/decode
StopMessage encode/decode
Constants

Description

Circuit Relay v2 message encoding/decoding (protobuf).

Two message types: HopMessage: client ↔ relay (RESERVE, CONNECT, STATUS) StopMessage: relay ↔ target (CONNECT, STATUS)

Wire format: [uvarint length][protobuf message]

HopMessage fields: type(1), peer(2), reservation(3), limit(4), status(5) StopMessage fields: type(1), peer(2), limit(3), status(4) Peer fields: id(1), addrs(2) Reservation fields: expire(1), addrs(2), voucher(3) Limit fields: duration(1), data(2)

Synopsis

data HopMessageType
- = HopReserve
- | HopConnect
- | HopStatus
data StopMessageType
- = StopConnect
- | StopStatus
data RelayStatus
- = RelayOK
- | ReservationRefused
- | ResourceLimitExceeded
- | PermissionDenied
- | ConnectionFailed
- | NoReservation
- | MalformedMessage
- | UnexpectedMessage
data RelayPeer = RelayPeer {
- rpId :: !ByteString
- rpAddrs :: ![ByteString]
}
data Reservation = Reservation {
- rsvExpire :: !(Maybe Word64)
- rsvAddrs :: ![ByteString]
- rsvVoucher :: !(Maybe ByteString)
}
data RelayLimit = RelayLimit {
- rlDuration :: !(Maybe Word32)
- rlData :: !(Maybe Word64)
}
data HopMessage = HopMessage {
- hopType :: !(Maybe HopMessageType)
- hopPeer :: !(Maybe RelayPeer)
- hopReservation :: !(Maybe Reservation)
- hopLimit :: !(Maybe RelayLimit)
- hopStatus :: !(Maybe RelayStatus)
}
data StopMessage = StopMessage {
- stopType :: !(Maybe StopMessageType)
- stopPeer :: !(Maybe RelayPeer)
- stopLimit :: !(Maybe RelayLimit)
- stopStatus :: !(Maybe RelayStatus)
}
relayStatusToWord :: RelayStatus -> Word32
wordToRelayStatus :: Word32 -> Maybe RelayStatus
encodeHopMessage :: HopMessage -> ByteString
decodeHopMessage :: ByteString -> Either ParseError HopMessage
encodeHopFramed :: HopMessage -> ByteString
decodeHopFramed :: Int -> ByteString -> Either String HopMessage
writeHopMessage :: StreamIO -> HopMessage -> IO ()
readHopMessage :: StreamIO -> Int -> IO (Either String HopMessage)
encodeStopMessage :: StopMessage -> ByteString
decodeStopMessage :: ByteString -> Either ParseError StopMessage
encodeStopFramed :: StopMessage -> ByteString
decodeStopFramed :: Int -> ByteString -> Either String StopMessage
writeStopMessage :: StreamIO -> StopMessage -> IO ()
readStopMessage :: StreamIO -> Int -> IO (Either String StopMessage)
maxRelayMessageSize :: Int
hopProtocolId :: Text
stopProtocolId :: Text

Types

data HopMessageType Source #

HopMessage type enum.

Constructors

HopReserve
HopConnect
HopStatus

Instances

Instances details

Show HopMessageType Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> HopMessageType -> ShowS # show :: HopMessageType -> String # showList :: [HopMessageType] -> ShowS #
Eq HopMessageType Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: HopMessageType -> HopMessageType -> Bool # (/=) :: HopMessageType -> HopMessageType -> Bool #

data StopMessageType Source #

StopMessage type enum.

Constructors

StopConnect
StopStatus

Instances

Instances details

Show StopMessageType Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> StopMessageType -> ShowS # show :: StopMessageType -> String # showList :: [StopMessageType] -> ShowS #
Eq StopMessageType Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: StopMessageType -> StopMessageType -> Bool # (/=) :: StopMessageType -> StopMessageType -> Bool #

data RelayStatus Source #

Relay status codes (shared between Hop and Stop).

Constructors

RelayOK	100
ReservationRefused	200
ResourceLimitExceeded	201
PermissionDenied	202
ConnectionFailed	203
NoReservation	204
MalformedMessage	400
UnexpectedMessage	401

Instances

Instances details

Show RelayStatus Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> RelayStatus -> ShowS # show :: RelayStatus -> String # showList :: [RelayStatus] -> ShowS #
Eq RelayStatus Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: RelayStatus -> RelayStatus -> Bool # (/=) :: RelayStatus -> RelayStatus -> Bool #

data RelayPeer Source #

Relay peer info (nested message).

Constructors

RelayPeer
Fields rpId :: !ByteString field 1: peer ID bytes rpAddrs :: ![ByteString] field 2: multiaddr bytes (repeated)

Instances

Instances details

Show RelayPeer Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> RelayPeer -> ShowS # show :: RelayPeer -> String # showList :: [RelayPeer] -> ShowS #
Eq RelayPeer Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: RelayPeer -> RelayPeer -> Bool # (/=) :: RelayPeer -> RelayPeer -> Bool #

data Reservation Source #

Reservation info (nested in HopMessage).

Constructors

Reservation
Fields rsvExpire :: !(Maybe Word64) field 1: expiration (Unix UTC) rsvAddrs :: ![ByteString] field 2: relay addresses rsvVoucher :: !(Maybe ByteString) field 3: signed envelope bytes

Instances

Instances details

Show Reservation Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> Reservation -> ShowS # show :: Reservation -> String # showList :: [Reservation] -> ShowS #
Eq Reservation Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: Reservation -> Reservation -> Bool # (/=) :: Reservation -> Reservation -> Bool #

data RelayLimit Source #

Relay limit (nested in both Hop and Stop).

Constructors

RelayLimit
Fields rlDuration :: !(Maybe Word32) field 1: max seconds (0=unlimited) rlData :: !(Maybe Word64) field 2: max bytes per direction

Instances

Instances details

Show RelayLimit Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> RelayLimit -> ShowS # show :: RelayLimit -> String # showList :: [RelayLimit] -> ShowS #
Eq RelayLimit Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: RelayLimit -> RelayLimit -> Bool # (/=) :: RelayLimit -> RelayLimit -> Bool #

data HopMessage Source #

HopMessage: client ↔ relay.

Constructors

HopMessage
Fields hopType :: !(Maybe HopMessageType) field 1 hopPeer :: !(Maybe RelayPeer) field 2 hopReservation :: !(Maybe Reservation) field 3 hopLimit :: !(Maybe RelayLimit) field 4 hopStatus :: !(Maybe RelayStatus) field 5

Instances

Instances details

Show HopMessage Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> HopMessage -> ShowS # show :: HopMessage -> String # showList :: [HopMessage] -> ShowS #
Eq HopMessage Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: HopMessage -> HopMessage -> Bool # (/=) :: HopMessage -> HopMessage -> Bool #

data StopMessage Source #

StopMessage: relay ↔ target.

Constructors

StopMessage
Fields stopType :: !(Maybe StopMessageType) field 1 stopPeer :: !(Maybe RelayPeer) field 2 stopLimit :: !(Maybe RelayLimit) field 3 stopStatus :: !(Maybe RelayStatus) field 4

Instances

Instances details

Show StopMessage Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods showsPrec :: Int -> StopMessage -> ShowS # show :: StopMessage -> String # showList :: [StopMessage] -> ShowS #
Eq StopMessage Source #
Instance details Defined in Network.LibP2P.NAT.Relay.Message Methods (==) :: StopMessage -> StopMessage -> Bool # (/=) :: StopMessage -> StopMessage -> Bool #