Moduledbus-1.4.1Haskell2010

DBus.Transport

Support for defining custom transport mechanisms. Most users will not need to care about the types defined in this module.

2 types
3 classes
5 values

Packagedbus-1.4.1
Exports10
LanguageHaskell2010
LicenceApache-2.0
SourceTransport.hs

Transports

3 declarations

classclass Transport t where

A Transport can exchange bytes with a remote peer.

Associated types

data family TransportOptions t
Additional options that this transport type may use when establishing a connection.

Methods

transportDefaultOptions :: TransportOptions t
Default values for this transport's options.
transportPut :: t -> ByteString -> IO ()
Send a ByteString over the transport.
Throws a TransportError if an error occurs.
transportPutWithFds :: t -> ByteString -> [Fd] -> IO ()
Send a ByteString and Unix file descriptors over the transport.
Throws a TransportError if an error occurs.
transportGet :: t -> Int -> IO ByteString
Receive a ByteString of the given size from the transport. The transport should block until sufficient bytes are available, and only return fewer than the requested amount if there will not be any more data.
Throws a TransportError if an error occurs.
transportGetWithFds :: t -> Int -> IO (ByteString, [Fd])
Receive a ByteString of the given size from the transport, plus any Unix file descriptors that arrive with the byte data. The transport should block until sufficient bytes are available, and only return fewer than the requested amount if there will not be any more data.
Throws a TransportError if an error occurs.
transportClose :: t -> IO ()
Close an open transport, and release any associated resources or handles.

Instances2Transport

Transport SomeTransportDefined in dbus-1.4.1 · DBus.Socket
Transport SocketTransportDefined in dbus-1.4.1 · DBus.Transport

classclass Transport t => TransportOpen t where

A Transport which can open a connection to a remote peer.

Methods

transportOpen :: TransportOptions t -> Address -> IO t
Open a connection to the given address, using the given options.
Throws a TransportError if the connection could not be established.

Instances1TransportOpen

TransportOpen SocketTransportDefined in dbus-1.4.1 · DBus.Transport

classclass Transport t => TransportListen t where

A Transport which can listen for and accept connections from remote peers.

Associated types

data family TransportListener t
Used for transports that listen on a port or address.

Methods

transportListen :: TransportOptions t -> Address -> IO (TransportListener t)
Begin listening for connections on the given address, using the given options.
Throws a TransportError if it's not possible to listen at that address (for example, if the port is already in use).
transportAccept :: TransportListener t -> IO t
Accept a new connection.
Throws a TransportError if some error happens before the transport is ready to exchange bytes.
transportListenerClose :: TransportListener t -> IO ()
Close an open listener.
transportListenerAddress :: TransportListener t -> Address
Get the address to use to connect to a listener.
transportListenerUUID :: TransportListener t -> UUID
Get the UUID allocated to this transport listener.
See randomUUID.

Instances1TransportListen

TransportListen SocketTransportDefined in dbus-1.4.1 · DBus.Transport

Transport errors

4 declarations

datadata TransportError

Thrown from transport methods when an error occurs.

Instances3Eq, Show, Exception

Eq TransportErrorDefined in dbus-1.4.1 · DBus.Transport
Show TransportErrorDefined in dbus-1.4.1 · DBus.Transport
Exception TransportErrorDefined in dbus-1.4.1 · DBus.Transport

valuetransportError :: String -> TransportError

valuetransportErrorMessage :: TransportError -> String

valuetransportErrorAddress :: TransportError -> Maybe Address

Socket transport

3 declarations

datadata SocketTransport

Supports connecting over Unix or TCP sockets.

Unix sockets are similar to pipes, but exist as special files in the filesystem. On Linux, abstract sockets have a path-like address, but do not actually have entries in the filesystem.

TCP sockets may use either IPv4 or IPv6.

Instances5TransportOpen, Transport, TransportListen, TransportListener, TransportOptions

TransportOpen SocketTransportDefined in dbus-1.4.1 · DBus.Transport
Transport SocketTransportDefined in dbus-1.4.1 · DBus.Transport
TransportListen SocketTransportDefined in dbus-1.4.1 · DBus.Transport
data TransportListener SocketTransport
- SocketTransportListener Address UUID Socket
Defined in dbus-1.4.1 · DBus.Transport
data TransportOptions SocketTransport
- SocketTransportOptionssocketTransportOptionBacklog :: Int
Defined in dbus-1.4.1 · DBus.Transport

valuesocketTransportOptionBacklog :: TransportOptions SocketTransport -> Int

valuesocketTransportCredentials

:: SocketTransport
-> IO (Maybe CUInt, Maybe CUInt, Maybe CUInt)

Returns the processID, userID, and groupID of the socket's peer.

See getPeerCredential.