Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Snocket

Contents

Snocket Interface
- Socket based Snocktes
- Local Snockets

Synopsis

newtype Accept m fd addr = Accept {
- runAccept :: m ( Accepted fd addr, Accept m fd addr)
}
data Accepted fd addr where
- AcceptFailure :: ! SomeException -> Accepted fd addr
- Accepted :: !fd -> !addr -> Accepted fd addr
data AddressFamily addr where
- SocketFamily :: ! Family -> AddressFamily SockAddr
- LocalFamily :: ! LocalAddress -> AddressFamily LocalAddress
- TestFamily :: AddressFamily ( TestAddress addr)
data Snocket m fd addr = Snocket {
- getLocalAddr :: fd -> m addr
- getRemoteAddr :: fd -> m addr
- addrFamily :: addr -> AddressFamily addr
- open :: AddressFamily addr -> m fd
- openToConnect :: addr -> m fd
- connect :: fd -> addr -> m ()
- bind :: fd -> addr -> m ()
- listen :: fd -> m ()
- accept :: fd -> m ( Accept m fd addr)
- close :: fd -> m ()
- toBearer :: DiffTime -> Tracer m MuxTrace -> fd -> m ( MuxBearer m)
}
type SocketSnocket = Snocket IO Socket SockAddr
socketSnocket :: IOManager -> SocketSnocket
type LocalSnocket = Snocket IO LocalSocket LocalAddress
localSnocket :: IOManager -> LocalSnocket
newtype LocalSocket = LocalSocket {
- getLocalHandle :: LocalHandle
}
newtype LocalAddress = LocalAddress {
- getFilePath :: FilePath
}
localAddressFromPath :: FilePath -> LocalAddress
newtype TestAddress addr = TestAddress {
- getTestAddress :: addr
}
newtype FileDescriptor = FileDescriptor {
- getFileDescriptor :: Int
}
socketFileDescriptor :: Socket -> IO FileDescriptor
localSocketFileDescriptor :: LocalSocket -> IO FileDescriptor

Snocket Interface

newtype Accept m fd addr Source #

Named pipes and Berkeley sockets have different API when accepting a connection. For named pipes the file descriptor created by createNamedPipe is supposed to be used for the first connected client. Named pipe accept loop looks this way:

acceptLoop k = do
  h <- createNamedPipe name
  connectNamedPipe h
  -- h is now in connected state
  forkIO (k h)
  acceptLoop k

For Berkeley sockets equivalent loop starts by creating a socket which accepts connections and accept returns a new socket in connected state

acceptLoop k = do
    s <- socket ...
    bind s address
    listen s
    loop s
  where
    loop s = do
      (s' , _addr') <- accept s
      -- s' is in connected state
      forkIO (k s')
      loop s

To make common API for both we use a recursive type Accept , see berkeleyAccept below. Creation of a socket / named pipe is part of Snocket , but this means we need to have different recursion step for named pipe & sockets. For sockets its recursion step will always return accept syscall; for named pipes the first callback will reuse the file descriptor created by open and only subsequent calls will create a new file descriptor by createNamedPipe , see namedPipeSnocket .

Constructors

Accept
Fields runAccept :: m ( Accepted fd addr, Accept m fd addr)

Instances

Instances details

Functor m => Bifunctor ( Accept m) Source #
Instance details Defined in Ouroboros.Network.Snocket Methods bimap :: (a -> b) -> (c -> d) -> Accept m a c -> Accept m b d Source # first :: (a -> b) -> Accept m a c -> Accept m b c Source # second :: (b -> c) -> Accept m a b -> Accept m a c Source #

data Accepted fd addr where Source #

Constructors

AcceptFailure :: ! SomeException -> Accepted fd addr
Accepted :: !fd -> !addr -> Accepted fd addr

Instances

Instances details

Bifunctor Accepted Source #
Instance details Defined in Ouroboros.Network.Snocket Methods bimap :: (a -> b) -> (c -> d) -> Accepted a c -> Accepted b d Source # first :: (a -> b) -> Accepted a c -> Accepted b c Source # second :: (b -> c) -> Accepted a b -> Accepted a c Source #
Bifoldable Accepted Source #
Instance details Defined in Ouroboros.Network.Snocket Methods bifold :: Monoid m => Accepted m m -> m Source # bifoldMap :: Monoid m => (a -> m) -> (b -> m) -> Accepted a b -> m Source # bifoldr :: (a -> c -> c) -> (b -> c -> c) -> c -> Accepted a b -> c Source # bifoldl :: (c -> a -> c) -> (c -> b -> c) -> c -> Accepted a b -> c Source #

data AddressFamily addr where Source #

We support either sockets or named pipes.

There are three families of addresses: SocketFamily usef for Berkeley sockets, LocalFamily used for LocalAddress es (either Unix sockets or Windows named pipe addresses), and TestFamily for testing purposes.

LocalFamily requires LocalAddress , this is needed to provide path of the opened Win32 HANDLE .

Constructors

SocketFamily :: ! Family -> AddressFamily SockAddr
LocalFamily :: ! LocalAddress -> AddressFamily LocalAddress
TestFamily :: AddressFamily ( TestAddress addr)	Using a newtype wrapper `TestAddress` makes pattern matches on `AddressFamily` complete, e.g. it makes `AddressFamily` injective: `AddressFamily addr == AddressFamily addr'` then `addr == addr'` . .

Instances

Instances details

Eq addr => Eq ( AddressFamily addr) Source #
Instance details Defined in Ouroboros.Network.Snocket Methods (==) :: AddressFamily addr -> AddressFamily addr -> Bool Source # (/=) :: AddressFamily addr -> AddressFamily addr -> Bool Source #
Show addr => Show ( AddressFamily addr) Source #
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> AddressFamily addr -> ShowS Source # show :: AddressFamily addr -> String Source # showList :: [ AddressFamily addr] -> ShowS Source #

data Snocket m fd addr Source #

Abstract communication interface that can be used by more than Socket . Snockets are polymorphic over monad which is used, this feature is useful for testing and/or simulations.

Constructors

Snocket

Fields

getLocalAddr :: fd -> m addr
getRemoteAddr :: fd -> m addr
addrFamily :: addr -> AddressFamily addr
open :: AddressFamily addr -> m fd

Open a file descriptor (socket / namedPipe). For named pipes this is using CreateNamedPipe syscall, for Berkeley sockets socket is used.
openToConnect :: addr -> m fd

A way to create fd to pass to connect . For named pipes it will use CreateFile syscall. For Berkeley sockets this the same as open .

For named pipes we need full addr rather than just address family as it is for sockets.
connect :: fd -> addr -> m ()

connect is only needed for Berkeley sockets, for named pipes this is no-op.
bind :: fd -> addr -> m ()
listen :: fd -> m ()
accept :: fd -> m ( Accept m fd addr)
close :: fd -> m ()
toBearer :: DiffTime -> Tracer m MuxTrace -> fd -> m ( MuxBearer m)

Socket based Snocktes

type SocketSnocket = Snocket IO Socket SockAddr Source #

socketSnocket Source #

Arguments

:: IOManager

IOManager interface. We use it when we create a new socket and when we accept a connection.

Though it could be used in open , but that is going to be used in a bracket so it's better to keep it simple.

-> SocketSnocket

Create a Snocket for the given Family . In the bind method set ReuseAddr and ReusePort .

Local Snockets

type LocalSnocket = Snocket IO LocalSocket LocalAddress Source #

System dependent LocalSnocket

localSnocket :: IOManager -> LocalSnocket Source #

Create a LocalSnocket .

On Windows , there is no way to get path associated to a named pipe. To go around this, the address passed to open via LocalFamily will be referenced by LocalSocket .

newtype LocalSocket Source #

System dependent LocalSnocket type

Constructors

LocalSocket
Fields getLocalHandle :: LocalHandle

Instances

Instances details

Eq LocalSocket Source #
Instance details Defined in Ouroboros.Network.Snocket Methods (==) :: LocalSocket -> LocalSocket -> Bool Source # (/=) :: LocalSocket -> LocalSocket -> Bool Source #
Show LocalSocket Source #
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> LocalSocket -> ShowS Source # show :: LocalSocket -> String Source # showList :: [ LocalSocket ] -> ShowS Source #
Generic LocalSocket Source #
Instance details Defined in Ouroboros.Network.Snocket Associated Types type Rep LocalSocket :: Type -> Type Source # Methods from :: LocalSocket -> Rep LocalSocket x Source # to :: Rep LocalSocket x -> LocalSocket Source #
type Rep LocalSocket Source #
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalSocket

newtype LocalAddress Source #

Local address, on Unix is associated with AF_UNIX family, on

Windows with `named-pipes`.

Constructors

LocalAddress
Fields getFilePath :: FilePath

Instances

Instances details

Eq LocalAddress Source #
Instance details Defined in Ouroboros.Network.Snocket Methods (==) :: LocalAddress -> LocalAddress -> Bool Source # (/=) :: LocalAddress -> LocalAddress -> Bool Source #
Ord LocalAddress Source #
Instance details Defined in Ouroboros.Network.Snocket Methods compare :: LocalAddress -> LocalAddress -> Ordering Source # (<) :: LocalAddress -> LocalAddress -> Bool Source # (<=) :: LocalAddress -> LocalAddress -> Bool Source # (>) :: LocalAddress -> LocalAddress -> Bool Source # (>=) :: LocalAddress -> LocalAddress -> Bool Source # max :: LocalAddress -> LocalAddress -> LocalAddress Source # min :: LocalAddress -> LocalAddress -> LocalAddress Source #
Show LocalAddress Source #
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> LocalAddress -> ShowS Source # show :: LocalAddress -> String Source # showList :: [ LocalAddress ] -> ShowS Source #
Generic LocalAddress Source #
Instance details Defined in Ouroboros.Network.Snocket Associated Types type Rep LocalAddress :: Type -> Type Source # Methods from :: LocalAddress -> Rep LocalAddress x Source # to :: Rep LocalAddress x -> LocalAddress Source #
Hashable LocalAddress Source #
Instance details Defined in Ouroboros.Network.Snocket Methods hashWithSalt :: Int -> LocalAddress -> Int Source # hash :: LocalAddress -> Int Source #
type Rep LocalAddress Source #
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalAddress = D1 (' MetaData "LocalAddress" "Ouroboros.Network.Snocket" "ouroboros-network-framework-0.1.0.1-8Cos8Lgj9CwATl9eblNk02" ' True ) ( C1 (' MetaCons "LocalAddress" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getFilePath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 FilePath )))

localAddressFromPath :: FilePath -> LocalAddress Source #

newtype TestAddress addr Source #

Constructors

TestAddress
Fields getTestAddress :: addr

Instances

Instances details

Eq addr => Eq ( TestAddress addr) Source #
Instance details Defined in Ouroboros.Network.Snocket Methods (==) :: TestAddress addr -> TestAddress addr -> Bool Source # (/=) :: TestAddress addr -> TestAddress addr -> Bool Source #
Ord addr => Ord ( TestAddress addr) Source #
Instance details Defined in Ouroboros.Network.Snocket Methods compare :: TestAddress addr -> TestAddress addr -> Ordering Source # (<) :: TestAddress addr -> TestAddress addr -> Bool Source # (<=) :: TestAddress addr -> TestAddress addr -> Bool Source # (>) :: TestAddress addr -> TestAddress addr -> Bool Source # (>=) :: TestAddress addr -> TestAddress addr -> Bool Source # max :: TestAddress addr -> TestAddress addr -> TestAddress addr Source # min :: TestAddress addr -> TestAddress addr -> TestAddress addr Source #
Show addr => Show ( TestAddress addr) Source #
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> TestAddress addr -> ShowS Source # show :: TestAddress addr -> String Source # showList :: [ TestAddress addr] -> ShowS Source #
Generic ( TestAddress addr) Source #
Instance details Defined in Ouroboros.Network.Snocket Associated Types type Rep ( TestAddress addr) :: Type -> Type Source # Methods from :: TestAddress addr -> Rep ( TestAddress addr) x Source # to :: Rep ( TestAddress addr) x -> TestAddress addr Source #
type Rep ( TestAddress addr) Source #
Instance details Defined in Ouroboros.Network.Snocket type Rep ( TestAddress addr) = D1 (' MetaData "TestAddress" "Ouroboros.Network.Snocket" "ouroboros-network-framework-0.1.0.1-8Cos8Lgj9CwATl9eblNk02" ' True ) ( C1 (' MetaCons "TestAddress" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getTestAddress") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 addr)))

newtype FileDescriptor Source #

Socket file descriptor.

Constructors

FileDescriptor
Fields getFileDescriptor :: Int

Instances

Instances details

Show FileDescriptor Source #
Instance details Defined in Ouroboros.Network.Snocket Methods showsPrec :: Int -> FileDescriptor -> ShowS Source # show :: FileDescriptor -> String Source # showList :: [ FileDescriptor ] -> ShowS Source #
Generic FileDescriptor Source #
Instance details Defined in Ouroboros.Network.Snocket Associated Types type Rep FileDescriptor :: Type -> Type Source # Methods from :: FileDescriptor -> Rep FileDescriptor x Source # to :: Rep FileDescriptor x -> FileDescriptor Source #
type Rep FileDescriptor Source #
Instance details Defined in Ouroboros.Network.Snocket type Rep FileDescriptor = D1 (' MetaData "FileDescriptor" "Ouroboros.Network.Snocket" "ouroboros-network-framework-0.1.0.1-8Cos8Lgj9CwATl9eblNk02" ' True ) ( C1 (' MetaCons "FileDescriptor" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getFileDescriptor") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int )))

socketFileDescriptor :: Socket -> IO FileDescriptor Source #

We use unsafeFdSocket but FileDescriptor constructor is not exposed. This forbids any usage of FileDescriptor (at least in a straightforward way) using any low level functions which operate on file descriptors.

localSocketFileDescriptor :: LocalSocket -> IO FileDescriptor Source #