Z.IO.Network.IPC

This module provides an API for creating IPC servers and clients. IPC Support is implemented with named pipes on Windows, and UNIX domain sockets on other operating systems.

On UNIX, the local domain is also known as the UNIX domain. The path is a filesystem path name. It gets truncated to sizeof(sockaddr_un.sun_path) - 1, which varies on different operating system between 91 and 107 bytes. The typical values are 107 on Linux and 103 on macOS. The path is subject to the same naming conventions and permissions checks as would be done on file creation. It will be visible in the filesystem, and will persist until unlinked.

On Windows, the local domain is implemented using a named pipe. The path must refer to an entry in \?pipe or \.pipe. Any characters are permitted, but the latter may do some processing of pipe names, such as resolving .. sequences. Despite appearances, the pipe name space is flat. Pipes will not persist, they are removed when the last reference to them is closed.

IPC Client

data IPCClientConfig

A IPC client configuration

Constructors

IPCClientConfig

Fields

• ipcClientName :: Maybe CBytes

  bind to a local file path (Unix) or name (Windows), won't bind if set to Nothing.

• ipcTargetName :: CBytes

  target path (Unix) or a name (Windows).

Instances

Eq IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

(==) :: IPCClientConfig -> IPCClientConfig -> Bool

(/=) :: IPCClientConfig -> IPCClientConfig -> Bool

Ord IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

compare :: IPCClientConfig -> IPCClientConfig -> Ordering

(<) :: IPCClientConfig -> IPCClientConfig -> Bool

(<=) :: IPCClientConfig -> IPCClientConfig -> Bool

(>) :: IPCClientConfig -> IPCClientConfig -> Bool

(>=) :: IPCClientConfig -> IPCClientConfig -> Bool

max :: IPCClientConfig -> IPCClientConfig -> IPCClientConfig

min :: IPCClientConfig -> IPCClientConfig -> IPCClientConfig

Read IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

readsPrec :: Int -> ReadS IPCClientConfig

readList :: ReadS [IPCClientConfig]

readPrec :: ReadPrec IPCClientConfig

readListPrec :: ReadPrec [IPCClientConfig]

Show IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

showsPrec :: Int -> IPCClientConfig -> ShowS

show :: IPCClientConfig -> String

showList :: [IPCClientConfig] -> ShowS

Generic IPCClientConfig

Defined in Z.IO.Network.IPC

Associated Types

type Rep IPCClientConfig :: Type -> Type

Methods

from :: IPCClientConfig -> Rep IPCClientConfig x

to :: Rep IPCClientConfig x -> IPCClientConfig

ToValue IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

toValue :: IPCClientConfig -> Value

EncodeJSON IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

encodeJSON :: IPCClientConfig -> Builder ()

FromValue IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

fromValue :: Value -> Converter IPCClientConfig

ShowT IPCClientConfig

Defined in Z.IO.Network.IPC

Methods

toUTF8BuilderP :: Int -> IPCClientConfig -> Builder ()

type Rep IPCClientConfig

Defined in Z.IO.Network.IPC

type Rep IPCClientConfig = D1 ('MetaData "IPCClientConfig" "Z.IO.Network.IPC" "Z-IO-0.1.9.0-A93JwU5skSk5dplvatrg1E" 'False) (C1 ('MetaCons "IPCClientConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipcClientName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CBytes)) :*: S1 ('MetaSel ('Just "ipcTargetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes)))

data UVStream

A haskell data type wrap an uv_stream_t inside

UVStream DO NOT provide thread safety! Use UVStream concurrently in multiple threads will lead to undefined behavior.

Instances

Show UVStream

Defined in Z.IO.UV.UVStream

Methods

showsPrec :: Int -> UVStream -> ShowS

show :: UVStream -> String

showList :: [UVStream] -> ShowS

ShowT UVStream

Defined in Z.IO.UV.UVStream

Methods

toUTF8BuilderP :: Int -> UVStream -> Builder ()

Output UVStream

Defined in Z.IO.UV.UVStream

Methods

writeOutput :: UVStream -> Ptr Word8 -> Int -> IO ()

Input UVStream

Defined in Z.IO.UV.UVStream

Methods

readInput :: UVStream -> Ptr Word8 -> Int -> IO Int

defaultIPCClientConfig :: IPCClientConfig

Default config, connect to "./ipc".

initIPCClient :: IPCClientConfig -> Resource UVStream

init a IPC client Resource, which open a new connect when used.

IPC Server

data IPCServerConfig

A IPC server configuration

Constructors

IPCServerConfig

Fields

• ipcListenName :: CBytes

  listening path (Unix) or a name (Windows).

• ipcListenBacklog :: Int

  listening pipe's backlog size, should be large enough(>128)

Instances

Eq IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

(==) :: IPCServerConfig -> IPCServerConfig -> Bool

(/=) :: IPCServerConfig -> IPCServerConfig -> Bool

Ord IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

compare :: IPCServerConfig -> IPCServerConfig -> Ordering

(<) :: IPCServerConfig -> IPCServerConfig -> Bool

(<=) :: IPCServerConfig -> IPCServerConfig -> Bool

(>) :: IPCServerConfig -> IPCServerConfig -> Bool

(>=) :: IPCServerConfig -> IPCServerConfig -> Bool

max :: IPCServerConfig -> IPCServerConfig -> IPCServerConfig

min :: IPCServerConfig -> IPCServerConfig -> IPCServerConfig

Read IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

readsPrec :: Int -> ReadS IPCServerConfig

readList :: ReadS [IPCServerConfig]

readPrec :: ReadPrec IPCServerConfig

readListPrec :: ReadPrec [IPCServerConfig]

Show IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

showsPrec :: Int -> IPCServerConfig -> ShowS

show :: IPCServerConfig -> String

showList :: [IPCServerConfig] -> ShowS

Generic IPCServerConfig

Defined in Z.IO.Network.IPC

Associated Types

type Rep IPCServerConfig :: Type -> Type

Methods

from :: IPCServerConfig -> Rep IPCServerConfig x

to :: Rep IPCServerConfig x -> IPCServerConfig

ToValue IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

toValue :: IPCServerConfig -> Value

EncodeJSON IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

encodeJSON :: IPCServerConfig -> Builder ()

FromValue IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

fromValue :: Value -> Converter IPCServerConfig

ShowT IPCServerConfig

Defined in Z.IO.Network.IPC

Methods

toUTF8BuilderP :: Int -> IPCServerConfig -> Builder ()

type Rep IPCServerConfig

Defined in Z.IO.Network.IPC

type Rep IPCServerConfig = D1 ('MetaData "IPCServerConfig" "Z.IO.Network.IPC" "Z-IO-0.1.9.0-A93JwU5skSk5dplvatrg1E" 'False) (C1 ('MetaCons "IPCServerConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipcListenName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CBytes) :*: S1 ('MetaSel ('Just "ipcListenBacklog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

defaultIPCServerConfig :: IPCServerConfig

A default hello world server on ./ipc

Test it with main = startIPCServer defaultIPCServerConfig

startIPCServer

Arguments

:: HasCallStack

=> IPCServerConfig

-> (UVStream -> IO ())

worker which get an accepted IPC stream, run in a seperated haskell thread, will be closed upon exception or worker finishes.

-> IO ()

Start a server

Fork new worker thread upon a new connection.

For test

helloWorld :: UVStream -> IO ()

Write "hello world" to a UVStream.

echo :: UVStream -> IO ()

Echo whatever received bytes.

Internal helper

initIPCStream :: HasCallStack => UVManager -> Resource UVStream