Erl.Kernel.Tcp

type Options :: Row Type -> Row Typetype Options r = CommonOptions (delay_send :: Maybe Boolean, exit_on_close :: Maybe Boolean, high_watermark :: Maybe NonNegInt, keepalive :: Maybe Boolean, linger :: Maybe Linger, low_watermark :: Maybe NonNegInt, nodelay :: Maybe Boolean, packet :: Maybe SocketPacket, packet_size :: Maybe NonNegInt, send_timeout :: Maybe Milliseconds, send_timeout_close :: Maybe Boolean, show_econnreset :: Maybe Boolean | r)

type ConnectListenOptions :: Row Type -> Row Typetype ConnectListenOptions r = Options (bind_to_device :: Maybe Binary, family :: Maybe AddressFamily, fd :: Maybe NonNegInt, ifaddr :: Maybe SocketAddress, ip :: Maybe SocketAddress, netns :: Maybe FileName, port :: Maybe Port | r)

type ConnectOptions :: Row Typetype ConnectOptions = ConnectListenOptions ()

type ListenOptions :: Row Typetype ListenOptions = ConnectListenOptions (backlog :: Maybe (NonNegInt))

data SocketPacket

Instances

• Eq SocketPacket
• ToErl SocketPacket

data OptionToMaybe

Constructors

• OptionToMaybe

Instances

• ConvertOption OptionToMaybe "mode" a a
• ConvertOption OptionToMaybe sym (Maybe a) (Maybe a)
• ConvertOption OptionToMaybe sym a (Maybe a)

data TcpSocket :: SocketMessageBehaviour -> SocketType -> Typedata TcpSocket t0 t1

Instances

• Eq (TcpSocket ActiveSocket ConnectedSocket)
• Eq (TcpSocket PassiveSocket ConnectedSocket)
• Eq (TcpSocket ActiveSocket ListenSocket)
• Eq (TcpSocket PassiveSocket ListenSocket)
• Show (TcpSocket ActiveSocket ConnectedSocket)
• Show (TcpSocket PassiveSocket ConnectedSocket)
• Show (TcpSocket ActiveSocket ListenSocket)
• Show (TcpSocket PassiveSocket ListenSocket)
• Socket (TcpSocket ActiveSocket ConnectedSocket)
• Socket (TcpSocket PassiveSocket ConnectedSocket)

data TcpMessage

Constructors

• Tcp (TcpSocket ActiveSocket ConnectedSocket) Binary
• Tcp_error (TcpSocket ActiveSocket ConnectedSocket) ActiveError
• Tcp_closed (TcpSocket ActiveSocket ConnectedSocket)
• Tcp_passive (TcpSocket ActiveSocket ConnectedSocket)

Instances

• Eq TcpMessage
• Show TcpMessage
• RuntimeType TcpMessage (RTOption (RTTuple3 (RTLiteralAtom "tcp") RTWildcard RTBinary) (RTOption (RTTuple3 (RTLiteralAtom "tcp_error") RTWildcard RTWildcard) (RTOption (RTTuple2 (RTLiteralAtom "tcp_closed") RTWildcard) (RTTuple2 (RTLiteralAtom "tcp_passive") RTWildcard))))

newtype Linger

Constructors

• Linger NonNegInt

Instances

• Eq Linger
• ToErl Linger

data ShutdownHow

Instances

• Eq ShutdownHow

data AcceptError

Constructors

• AcceptClosed
• AcceptTimeout
• AcceptSystemLimit
• AcceptPosix PosixError

Instances

• Eq AcceptError
• Generic AcceptError _
• Show AcceptError

data ListenError

Constructors

• ListenSystemLimit
• ListenPosix PosixError

Instances

• Eq ListenError
• Generic ListenError _
• Show ListenError

defaultConnectListenOptions :: forall r. Union r (ConnectListenOptions ()) (ConnectListenOptions r) => Record r -> Record (ConnectListenOptions r)

defaultConnectOptions :: Record ConnectOptions

defaultListenOptions :: Record ListenOptions

connectOptions :: forall options. ConvertOptionsWithDefaults OptionToMaybe (Record ConnectOptions) options (Record ConnectOptions) => options -> Record ConnectOptions

listenOptions :: forall options. ConvertOptionsWithDefaults OptionToMaybe (Record ListenOptions) options (Record ListenOptions) => options -> Record ListenOptions

accept :: forall m. MonadEffect m => CanReceiveMessage TcpMessage m => TcpSocket ActiveSocket ListenSocket -> Timeout -> m (Either AcceptError (TcpSocket ActiveSocket ConnectedSocket))

acceptPassive :: TcpSocket PassiveSocket ListenSocket -> Timeout -> Effect (Either AcceptError (TcpSocket PassiveSocket ConnectedSocket))

close :: forall socketMessageBehaviour socketType. TcpSocket socketMessageBehaviour socketType -> Effect Unit

connect :: forall options m. MonadEffect m => CanReceiveMessage TcpMessage m => Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record ConnectOptions) (Record (ForcedOptions options)) (Record (ForcedOptions ConnectOptions)) => ConnectAddress -> Port -> Record options -> Timeout -> m (Either ConnectError (TcpSocket ActiveSocket ConnectedSocket))

connectPassive :: forall options. Lacks "active" options => Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record ConnectOptions) (Record (ForcedOptions options)) (Record (ForcedOptions ConnectOptions)) => ConnectAddress -> Port -> Record options -> Timeout -> Effect (Either ConnectError (TcpSocket PassiveSocket ConnectedSocket))

listen :: forall options. Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record ListenOptions) (Record (ForcedOptions options)) (Record (ForcedOptions ListenOptions)) => Port -> Record options -> Effect (Either ListenError (TcpSocket ActiveSocket ListenSocket))

listenPassive :: forall options. Lacks "active" options => Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record ListenOptions) (Record (ForcedOptions options)) (Record (ForcedOptions ListenOptions)) => Port -> Record options -> Effect (Either ListenError (TcpSocket PassiveSocket ListenSocket))

recv :: forall socketMessageBehaviour. TcpSocket socketMessageBehaviour ConnectedSocket -> NonNegInt -> Timeout -> Effect (Either ActiveError Binary)

send :: forall socketMessageBehaviour. TcpSocket socketMessageBehaviour ConnectedSocket -> IOData -> Effect (Either SendError Unit)

shutdown :: forall socketMessageBehaviour socketType. TcpSocket socketMessageBehaviour socketType -> ShutdownHow -> Effect (Either PosixError Unit)

setopts :: forall options socketMessageBehaviour socketType. Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record (Options ())) (Record (ForcedOptions options)) (Record (ForcedOptions (Options ()))) => OptionsValid socketMessageBehaviour options => TcpSocket socketMessageBehaviour socketType -> Record options -> Effect (Either PosixError Unit)

convertPassiveToActive :: forall m. MonadEffect m => CanReceiveMessage TcpMessage m => TcpSocket PassiveSocket ConnectedSocket -> TcpSocket ActiveSocket ConnectedSocket