network-3.0.0.1: README.md

# [`network`](http://hackage.haskell.org/package/network) [![Build Status](https://travis-ci.org/haskell/network.svg?branch=master)](https://travis-ci.org/haskell/network) [![Build status](https://ci.appveyor.com/api/projects/status/5erq63o4m29bhl57/branch/master?svg=true)](https://ci.appveyor.com/project/eborden/network/branch/master)

To build this package directly from git, you must run `autoreconf -i`.
And then use `cabal configure; cabal build` or `stack build`.

## Support Policy

### GHC

The `network` package support [3 major versions of GHC](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/intro.html#ghc-version-numbering-policy) only.
This means that the current stable version and two previous stable versions are supported.

### Windows

We use MSYS to build this package on Windows.
To use the `network` package on Cygwin, use `stack`.

## Coding

### .hs files

If you need C macros created by "configure" or `CALLCONV`/`SAFE_ON_WIN`, put

```
#include "HsNetDef.h"
```

"HsNet.h" does now work well since Mac's cpp sucks.

### .hsc files

If you need `#peek`, `#poke` and others, create a `.hsc` file with

```
#include "HsNet.h"
```

`HsNet.h` includes `HsNefDef.h` and necessary C structures.
Unfortunately, `hsc2hs` does not convert C macros.
So, if you use `CALLCONV`/`SAFE_ON_WIN`, the following is also necessary:

```
##include "HsNetDef.h"
```

## Milestones

### 2.6

- [x] Making `SockAddrCan` deprecated

### 2.7

See https://github.com/haskell/network/issues/296

- [x] Making `Network` deprecated
- [x] Making `Network.BSD` deprecated
- [x] Making `MkSocket` deprecated
- [x] Making many APIs deprecated

### 2.8

- [x] Stop exporting the `PortNum` Constructor in `PortNumber`

### 3.0

- [x] Removing `Network`
- [x] Removing `Network.BSD`
- [x] Removing `SockAddrCan`
- [x] Changing the internal structure of `Socket`.
- [x] Make address extensible.
- [x] Remove EOF errors