Transport

This module exposes a Transport type class that is used to represent different transport mechanisms that can be used with an HTTP connection.

class Std.Http.Transport (α : Type) : Type

Generic HTTP interface that abstracts over different transport mechanisms.

• recv : α → UInt64 → Async.Async (Option ByteArray)

  Receive data from the client connection, up to the expected size. Returns None if the connection is closed or no data is available.

• sendAll : α → Array ByteArray → Async.Async Unit

  Send all data through the client connection.

• recvSelector : α → UInt64 → Async.Selector (Option ByteArray)

  Get a selector for receiving data asynchronously.

• close : α → IO Unit

  Close the transport connection. The default implementation is a no-op; override this for transports that require explicit teardown. For Socket.Client, the runtime closes the file descriptor when the object is finalized.

@[implicit_reducible]

instance Std.Http.instTransportClient : Transport Async.TCP.Socket.Client

Equations

• One or more equations did not get rendered due to their size.

structure Std.Http.Internal.Mock.Client : Type

Mock client endpoint for testing.

• shared : SharedState

structure Std.Http.Internal.Mock.Server : Type

Mock server endpoint for testing.

• shared : SharedState

def Std.Http.Internal.Mock.new : BaseIO (Client × Server)

Creates a mock server and client that are connected to each other and share the same underlying state, enabling bidirectional communication.

Equations

• One or more equations did not get rendered due to their size.

def Std.Http.Internal.Mock.recvJoined (recvChan : CloseableChannel ByteArray) (expect : Option UInt64) : Async.Async (Option ByteArray)

Receives data from a channel, joining all available data up to the expected size. First does a blocking recv, then greedily consumes available data with tryRecv until expect bytes are reached.

Equations

• One or more equations did not get rendered due to their size.

def Std.Http.Internal.Mock.send (sendChan : CloseableChannel ByteArray) (data : ByteArray) : Async.Async Unit

Sends a single ByteArray through a channel.

Equations

• Std.Http.Internal.Mock.send sendChan data = do let __do_lift ← liftM (sendChan.send data) Std.Async.Async.ofAsyncTask (Task.map (Except.mapError (IO.userError ∘ toString)) __do_lift)

def Std.Http.Internal.Mock.sendAll (sendChan : CloseableChannel ByteArray) (data : Array ByteArray) : Async.Async Unit

Sends ByteArrays through a channel.

Equations

• One or more equations did not get rendered due to their size.

def Std.Http.Internal.Mock.recvSelector (recvChan : CloseableChannel ByteArray) : Async.Selector (Option ByteArray)

Creates a selector for receiving from a channel.

Equations

• Std.Http.Internal.Mock.recvSelector recvChan = recvChan.recvSelector

def Std.Http.Internal.Mock.Client.getRecvChan (client : Client) : CloseableChannel ByteArray

Gets the receive channel for a client (server to client direction).

Equations

• client.getRecvChan = Std.Http.Internal.Mock.SharedState.serverToClient✝ (Std.Http.Internal.Mock.Client.shared✝ client)

def Std.Http.Internal.Mock.Client.getSendChan (client : Client) : CloseableChannel ByteArray

Gets the send channel for a client (client to server direction).

Equations

• client.getSendChan = Std.Http.Internal.Mock.SharedState.clientToServer✝ (Std.Http.Internal.Mock.Client.shared✝ client)

def Std.Http.Internal.Mock.Client.send (client : Client) (data : ByteArray) : Async.Async Unit

Sends a single ByteArray.

Equations

• client.send data = Std.Http.Internal.Mock.send client.getSendChan data

def Std.Http.Internal.Mock.Client.recv? (client : Client) (expect : Option UInt64 := none) : Async.Async (Option ByteArray)

Receives data, joining all available chunks.

Equations

• client.recv? expect = Std.Http.Internal.Mock.recvJoined client.getRecvChan expect

def Std.Http.Internal.Mock.Client.tryRecv? (client : Client) (_expect : UInt64 := 0) : BaseIO (Option ByteArray)

Tries to receive data without blocking, joining all immediately available chunks. Returns none if no data is available.

Equations

• One or more equations did not get rendered due to their size.

def Std.Http.Internal.Mock.Client.close (client : Client) : IO Unit

Closes the mock server and client.

Equations

• One or more equations did not get rendered due to their size.

def Std.Http.Internal.Mock.Server.getRecvChan (server : Server) : CloseableChannel ByteArray

Gets the receive channel for a server (client to server direction).

Equations

• server.getRecvChan = Std.Http.Internal.Mock.SharedState.clientToServer✝ (Std.Http.Internal.Mock.Server.shared✝ server)

def Std.Http.Internal.Mock.Server.getSendChan (server : Server) : CloseableChannel ByteArray

Gets the send channel for a server (server to client direction).

Equations

• server.getSendChan = Std.Http.Internal.Mock.SharedState.serverToClient✝ (Std.Http.Internal.Mock.Server.shared✝ server)

def Std.Http.Internal.Mock.Server.send (server : Server) (data : ByteArray) : Async.Async Unit

Sends a single ByteArray.

Equations

• server.send data = Std.Http.Internal.Mock.send server.getSendChan data

def Std.Http.Internal.Mock.Server.recv? (server : Server) (expect : Option UInt64 := none) : Async.Async (Option ByteArray)

Receives data, joining all available chunks.

Equations

• server.recv? expect = Std.Http.Internal.Mock.recvJoined server.getRecvChan expect

def Std.Http.Internal.Mock.Server.tryRecv? (server : Server) (_expect : UInt64 := 0) : BaseIO (Option ByteArray)

Tries to receive data without blocking, joining all immediately available chunks. Returns none if no data is available.

Equations

• One or more equations did not get rendered due to their size.

def Std.Http.Internal.Mock.Server.close (server : Server) : IO Unit

Closes the mock server and client.

Equations

• One or more equations did not get rendered due to their size.

@[implicit_reducible]

instance Std.Http.Internal.instTransportClient : Transport Mock.Client

Equations

• One or more equations did not get rendered due to their size.

@[implicit_reducible]

instance Std.Http.Internal.instTransportServer : Transport Mock.Server

Equations

• One or more equations did not get rendered due to their size.