Stability	experimental
Portability	Linux, OS X
Safe Haskell	None
Language	Haskell2010

System.Socket.Family.Unix

Contents

Exceptions

Description

Synopsis

data Unix
data family SocketAddress f
data family SocketAddress f
socketAddressUnixPath :: ByteString -> Maybe (SocketAddress Unix)
socketAddressUnixAbstract :: ByteString -> Maybe (SocketAddress Unix)
getUnixPath :: SocketAddress Unix -> Maybe ByteString
eNoEntry :: SocketException

Documentation

data Unix #

The Unix domain socket

Instances

Instances details

Family Unix #

Instance details

Defined in System.Socket.Family.Unix.Platform

Associated Types

data SocketAddress Unix
Instance details Defined in System.Socket.Family.Unix.Platform data SocketAddress Unix = SocketAddressUnixPath ByteString \| SocketAddressUnixAbstract ByteString

Methods

familyNumber :: Unix -> CInt #

Storable (SocketAddress Unix) #

Instance details

Defined in System.Socket.Family.Unix.Platform

Methods

sizeOf :: SocketAddress Unix -> Int #

alignment :: SocketAddress Unix -> Int #

peekElemOff :: Ptr (SocketAddress Unix) -> Int -> IO (SocketAddress Unix) #

pokeElemOff :: Ptr (SocketAddress Unix) -> Int -> SocketAddress Unix -> IO () #

peekByteOff :: Ptr b -> Int -> IO (SocketAddress Unix) #

pokeByteOff :: Ptr b -> Int -> SocketAddress Unix -> IO () #

peek :: Ptr (SocketAddress Unix) -> IO (SocketAddress Unix) #

poke :: Ptr (SocketAddress Unix) -> SocketAddress Unix -> IO () #

Show (SocketAddress Unix) #

Instance details

Defined in System.Socket.Family.Unix.Platform

Methods

showsPrec :: Int -> SocketAddress Unix -> ShowS #

show :: SocketAddress Unix -> String #

showList :: [SocketAddress Unix] -> ShowS #

Eq (SocketAddress Unix) #

Instance details

Defined in System.Socket.Family.Unix.Platform

Methods

(==) :: SocketAddress Unix -> SocketAddress Unix -> Bool #

(/=) :: SocketAddress Unix -> SocketAddress Unix -> Bool #

data SocketAddress Unix #

Instance details

Defined in System.Socket.Family.Unix.Platform

data SocketAddress Unix

= SocketAddressUnixPath ByteString
| SocketAddressUnixAbstract ByteString

data family SocketAddress f #

The SocketAddress type is a data family. This allows to provide different data constructors depending on the socket family without knowing all of them in advance or the need to extend this core library.

SocketAddressInet  inetLoopback  8080     :: SocketAddress Inet
SocketAddressInet6 inet6Loopback 8080 0 0 :: SocketAddress Inet6

Instances

Instances details

Storable (SocketAddress Inet)
Instance details Defined in System.Socket.Family.Inet Methods sizeOf :: SocketAddress Inet -> Int # alignment :: SocketAddress Inet -> Int # peekElemOff :: Ptr (SocketAddress Inet) -> Int -> IO (SocketAddress Inet) # pokeElemOff :: Ptr (SocketAddress Inet) -> Int -> SocketAddress Inet -> IO () # peekByteOff :: Ptr b -> Int -> IO (SocketAddress Inet) # pokeByteOff :: Ptr b -> Int -> SocketAddress Inet -> IO () # peek :: Ptr (SocketAddress Inet) -> IO (SocketAddress Inet) # poke :: Ptr (SocketAddress Inet) -> SocketAddress Inet -> IO () #
Storable (SocketAddress Inet6)
Instance details Defined in System.Socket.Family.Inet6 Methods sizeOf :: SocketAddress Inet6 -> Int # alignment :: SocketAddress Inet6 -> Int # peekElemOff :: Ptr (SocketAddress Inet6) -> Int -> IO (SocketAddress Inet6) # pokeElemOff :: Ptr (SocketAddress Inet6) -> Int -> SocketAddress Inet6 -> IO () # peekByteOff :: Ptr b -> Int -> IO (SocketAddress Inet6) # pokeByteOff :: Ptr b -> Int -> SocketAddress Inet6 -> IO () # peek :: Ptr (SocketAddress Inet6) -> IO (SocketAddress Inet6) # poke :: Ptr (SocketAddress Inet6) -> SocketAddress Inet6 -> IO () #
Storable (SocketAddress Unix) #
Instance details Defined in System.Socket.Family.Unix.Platform Methods sizeOf :: SocketAddress Unix -> Int # alignment :: SocketAddress Unix -> Int # peekElemOff :: Ptr (SocketAddress Unix) -> Int -> IO (SocketAddress Unix) # pokeElemOff :: Ptr (SocketAddress Unix) -> Int -> SocketAddress Unix -> IO () # peekByteOff :: Ptr b -> Int -> IO (SocketAddress Unix) # pokeByteOff :: Ptr b -> Int -> SocketAddress Unix -> IO () # peek :: Ptr (SocketAddress Unix) -> IO (SocketAddress Unix) # poke :: Ptr (SocketAddress Unix) -> SocketAddress Unix -> IO () #
Show (SocketAddress Inet)
Instance details Defined in System.Socket.Family.Inet Methods showsPrec :: Int -> SocketAddress Inet -> ShowS # show :: SocketAddress Inet -> String # showList :: [SocketAddress Inet] -> ShowS #
Show (SocketAddress Inet6)
Instance details Defined in System.Socket.Family.Inet6 Methods showsPrec :: Int -> SocketAddress Inet6 -> ShowS # show :: SocketAddress Inet6 -> String # showList :: [SocketAddress Inet6] -> ShowS #
Show (SocketAddress Unix) #
Instance details Defined in System.Socket.Family.Unix.Platform Methods showsPrec :: Int -> SocketAddress Unix -> ShowS # show :: SocketAddress Unix -> String # showList :: [SocketAddress Unix] -> ShowS #
Eq (SocketAddress Inet)
Instance details Defined in System.Socket.Family.Inet Methods (==) :: SocketAddress Inet -> SocketAddress Inet -> Bool # (/=) :: SocketAddress Inet -> SocketAddress Inet -> Bool #
Eq (SocketAddress Inet6)
Instance details Defined in System.Socket.Family.Inet6 Methods (==) :: SocketAddress Inet6 -> SocketAddress Inet6 -> Bool # (/=) :: SocketAddress Inet6 -> SocketAddress Inet6 -> Bool #
Eq (SocketAddress Unix) #
Instance details Defined in System.Socket.Family.Unix.Platform Methods (==) :: SocketAddress Unix -> SocketAddress Unix -> Bool # (/=) :: SocketAddress Unix -> SocketAddress Unix -> Bool #
data SocketAddress Inet
Instance details Defined in System.Socket.Family.Inet data SocketAddress Inet = SocketAddressInet { inetAddress :: InetAddress inetPort :: InetPort }
data SocketAddress Inet6
Instance details Defined in System.Socket.Family.Inet6 data SocketAddress Inet6 = SocketAddressInet6 { inet6Address :: Inet6Address inet6Port :: Inet6Port inet6FlowInfo :: Inet6FlowInfo inet6ScopeId :: Inet6ScopeId }
data SocketAddress Unix #
Instance details Defined in System.Socket.Family.Unix.Platform data SocketAddress Unix = SocketAddressUnixPath ByteString \| SocketAddressUnixAbstract ByteString

data family SocketAddress f #

The SocketAddress type is a data family. This allows to provide different data constructors depending on the socket family without knowing all of them in advance or the need to extend this core library.

SocketAddressInet  inetLoopback  8080     :: SocketAddress Inet
SocketAddressInet6 inet6Loopback 8080 0 0 :: SocketAddress Inet6

Instances

Instances details

Storable (SocketAddress Inet)
Instance details Defined in System.Socket.Family.Inet Methods sizeOf :: SocketAddress Inet -> Int # alignment :: SocketAddress Inet -> Int # peekElemOff :: Ptr (SocketAddress Inet) -> Int -> IO (SocketAddress Inet) # pokeElemOff :: Ptr (SocketAddress Inet) -> Int -> SocketAddress Inet -> IO () # peekByteOff :: Ptr b -> Int -> IO (SocketAddress Inet) # pokeByteOff :: Ptr b -> Int -> SocketAddress Inet -> IO () # peek :: Ptr (SocketAddress Inet) -> IO (SocketAddress Inet) # poke :: Ptr (SocketAddress Inet) -> SocketAddress Inet -> IO () #
Storable (SocketAddress Inet6)
Instance details Defined in System.Socket.Family.Inet6 Methods sizeOf :: SocketAddress Inet6 -> Int # alignment :: SocketAddress Inet6 -> Int # peekElemOff :: Ptr (SocketAddress Inet6) -> Int -> IO (SocketAddress Inet6) # pokeElemOff :: Ptr (SocketAddress Inet6) -> Int -> SocketAddress Inet6 -> IO () # peekByteOff :: Ptr b -> Int -> IO (SocketAddress Inet6) # pokeByteOff :: Ptr b -> Int -> SocketAddress Inet6 -> IO () # peek :: Ptr (SocketAddress Inet6) -> IO (SocketAddress Inet6) # poke :: Ptr (SocketAddress Inet6) -> SocketAddress Inet6 -> IO () #
Storable (SocketAddress Unix) #
Instance details Defined in System.Socket.Family.Unix.Platform Methods sizeOf :: SocketAddress Unix -> Int # alignment :: SocketAddress Unix -> Int # peekElemOff :: Ptr (SocketAddress Unix) -> Int -> IO (SocketAddress Unix) # pokeElemOff :: Ptr (SocketAddress Unix) -> Int -> SocketAddress Unix -> IO () # peekByteOff :: Ptr b -> Int -> IO (SocketAddress Unix) # pokeByteOff :: Ptr b -> Int -> SocketAddress Unix -> IO () # peek :: Ptr (SocketAddress Unix) -> IO (SocketAddress Unix) # poke :: Ptr (SocketAddress Unix) -> SocketAddress Unix -> IO () #
Show (SocketAddress Inet)
Instance details Defined in System.Socket.Family.Inet Methods showsPrec :: Int -> SocketAddress Inet -> ShowS # show :: SocketAddress Inet -> String # showList :: [SocketAddress Inet] -> ShowS #
Show (SocketAddress Inet6)
Instance details Defined in System.Socket.Family.Inet6 Methods showsPrec :: Int -> SocketAddress Inet6 -> ShowS # show :: SocketAddress Inet6 -> String # showList :: [SocketAddress Inet6] -> ShowS #
Show (SocketAddress Unix) #
Instance details Defined in System.Socket.Family.Unix.Platform Methods showsPrec :: Int -> SocketAddress Unix -> ShowS # show :: SocketAddress Unix -> String # showList :: [SocketAddress Unix] -> ShowS #
Eq (SocketAddress Inet)
Instance details Defined in System.Socket.Family.Inet Methods (==) :: SocketAddress Inet -> SocketAddress Inet -> Bool # (/=) :: SocketAddress Inet -> SocketAddress Inet -> Bool #
Eq (SocketAddress Inet6)
Instance details Defined in System.Socket.Family.Inet6 Methods (==) :: SocketAddress Inet6 -> SocketAddress Inet6 -> Bool # (/=) :: SocketAddress Inet6 -> SocketAddress Inet6 -> Bool #
Eq (SocketAddress Unix) #
Instance details Defined in System.Socket.Family.Unix.Platform Methods (==) :: SocketAddress Unix -> SocketAddress Unix -> Bool # (/=) :: SocketAddress Unix -> SocketAddress Unix -> Bool #
data SocketAddress Inet
Instance details Defined in System.Socket.Family.Inet data SocketAddress Inet = SocketAddressInet { inetAddress :: InetAddress inetPort :: InetPort }
data SocketAddress Inet6
Instance details Defined in System.Socket.Family.Inet6 data SocketAddress Inet6 = SocketAddressInet6 { inet6Address :: Inet6Address inet6Port :: Inet6Port inet6FlowInfo :: Inet6FlowInfo inet6ScopeId :: Inet6ScopeId }
data SocketAddress Unix #
Instance details Defined in System.Socket.Family.Unix.Platform data SocketAddress Unix = SocketAddressUnixPath ByteString \| SocketAddressUnixAbstract ByteString

socketAddressUnixPath :: ByteString -> Maybe (SocketAddress Unix) #

Creates address which is connected to a filesystem pathname. Returns Nothing if path's length exceeds maximal supported.

socketAddressUnixAbstract :: ByteString -> Maybe (SocketAddress Unix) #

Creates address with name in abstract namespace. Returns Nothing if path's length exceeds maximal supported.

getUnixPath :: SocketAddress Unix -> Maybe ByteString #

Returns filesystem pathname where address is connected to.

Exceptions

eNoEntry :: SocketException #

SocketException "No such file or directory"