Skip to content

Commit

Permalink
Updated README for v0.4 and added CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
fpagliughi committed Jun 30, 2019
1 parent c51b35f commit 196c21f
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 15 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Change Log

## Version 0.4

The work in this branch is proceeding to add support for IPv6 and refactor the class hierarchies to better support the different address families without so much redundant code.

- IPv6 support: `inet6_address`, `tcp6_acceptor`, `tcp_connector`, etc.
- (Breaking change) The `sock_address` class is now contains storage for any type of address and follows copy semantics. Previously it was a non-owning reference class. That reference class now exists as `sock_addresss_ref`.
- Generic base classses are being re-implemented to use _sock_address_ and _sock_address_ref_ as generic addresses.
- (Breaking change) In the `socket` class(es) the `bool address(address&)` and `bool peer_address(addr&)` forms of getting the socket addresses have been removed in favor of the ones that simply return the address.
Added `get_option()` and `set_option()` methods to the base `socket`class.
- The GNU Make build system (Makefile) was deprecated and removed.

## Version 0.3

- Socket class hierarcy now splits out for streaming and datagram sockets.
- Support for UNIX-domain sockets.
- New modern CMake build system.
- GNU Make system marked for deprecation.

## Version 0.2

- Initial working version for IPv4.
- API using boolean return values for pass/fail functions instead of syscall-style integers.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ To keep up with the latest announcements for this project, follow me at:

**Twitter:** [@fmpagliughi](https://twitter.com/fmpagliughi)

## Unreleased Features and Updates (in this branch)
## What's New in Version v0.4

The work in this branch is proceeding to add support for IPv6 and refactor the class hierarchies to better support the different address families without so much redundant code.
Version 0.4 added support for IPv6 and refactored the class hierarchies to better support the different address families without so much redundant code.

- IPv6 support: `inet6_address`, `tcp6_acceptor`, `tcp_connector`, etc.
- (Breaking change) The `sock_address` class is now contains storage for any type of address and follows copy semantics. Previously it was a non-owning reference class. That reference class now exists as `sock_addresss_ref`.
- **(Breaking change)** The `sock_address` class is now contains storage for any type of address and follows copy semantics. Previously it was a non-owning reference class. That reference class now exists as `sock_addresss_ref`.
- Generic base classses are being re-implemented to use _sock_address_ and _sock_address_ref_ as generic addresses.
- (Breaking change) In the `socket` class(es) the `bool address(address&)` and `bool peer_address(addr&)` forms of getting the socket addresses have been removed in favor of the ones that simply return the address.
- **(Breaking change)** In the `socket` class(es) the `bool address(address&)` and `bool peer_address(addr&)` forms of getting the socket addresses have been removed in favor of the ones that simply return the address.
Added `get_option()` and `set_option()` methods to the base `socket`class.
- The GNU Make build system (Makefile) was deprecated and removed.

## Coming Soon
## Coming Soon

The following improvements are soon to follow:

Expand All @@ -39,18 +39,9 @@ The work in this branch is proceeding to add support for IPv6 and refactor the c

- **SSL Sockets.** It might be nice to add optional support for secure sockets.

## What's new in v0.3

Version 0.3 brings several new features:

- Socket class hierarcy now splits out for streaming and datagram sockets.
- Support for UNIX-domain sockets.
- New modern CMake build system.
- GNU Make system marked for deprecation.

## Building the Library

CMake is now the supported build system.
CMake is the supported build system.

### Requirements:

Expand Down

0 comments on commit 196c21f

Please sign in to comment.