Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix examples in README #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix examples in README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ A Unix domain socket API for the [socket](https://github.com/lpeterse/haskell-so
Creating the Unix domain socket:
```haskell
import System.Socket
import System.Socket.Protocol.Default
import System.Socket.Type.Stream
import System.Socket.Family.Unix

s <- socket :: IO (Socket Unix Stream Unix)
s <- socket :: IO (Socket Unix Stream Default)
```

Creating the address for binding/connecting
```haskell
address <- case socketAddressUnixPath "example.sock" of
Just addr -> pure addr
Nothing -> putStrLn "invalid pathname for socket"
Nothing -> fail "invalid pathname for socket"
```
### Symlinks
Binding to a socket with a filename creates a socket in the filesystem, but does not unlink it after `close` called. You should handle deleting links yourself.
Expand Down