Send packets over TCP and UDP. It can buffer messages and hot-swap connections if needed.

# packet

[![Godoc][godoc-image]][godoc-url]
[![Report][report-image]][report-url]
[![Tests][tests-image]][tests-url]
[![Coverage][coverage-image]][coverage-url]
[![Sponsor][sponsor-image]][sponsor-url]

Send network packets over a TCP or UDP connection.

## Packet

Packet is the main class representing a single network message. It has a byte code indicating the type of the message and a `[]byte` type payload.

## Stream

A stream has a send and receive channel with a hot-swappable connection for reconnects.
The user has the responsibility to register a callback to consume errors via `OnError`.

## Example

```go
// Connect to a server
conn, _ := net.Dial("tcp", "localhost:7000")

// Create a stream
stream := packet.NewStream(1024)
stream.SetConnection(conn)

// Send a message
stream.Outgoing <- packet.New(0, []byte("ping"))

// Receive message
msg := <-stream.Incoming

// Check message contents
if string(msg.Data) != "pong" 
```

## Hot-swap example

```go
// Close server connection to simulate server death
server.Close()

// Send packet while server is down (will be buffered until it reconnects)
client.Outgoing <- packet.New(0, []byte("ping"))

// Reconnect
newServer, _ := net.Dial("tcp", "localhost:7000")

// Hot-swap connection
client.SetConnection(newServer)

// The previously buffered messages in the Outgoing channel will be sent now.
```

## Style

Please take a look at the [style guidelines](https://github.com/akyoto/quality/blob/master/STYLE.md) if you'd like to make a pull request.

## Sponsors

| [![Cedric Fung](https://avatars3.githubusercontent.com/u/2269238?s=70&v=4)](https://github.com/cedricfung) | [![Scott Rayapoullé](https://avatars3.githubusercontent.com/u/11772084?s=70&v=4)](https://github.com/soulcramer) | [![Eduard Urbach](https://avatars3.githubusercontent.com/u/438936?s=70&v=4)](https://twitter.com/eduardurbach) |
| --- | --- | --- |
| [Cedric Fung](https://github.com/cedricfung) | [Scott Rayapoullé](https://github.com/soulcramer) | [Eduard Urbach](https://eduardurbach.com) |

Want to see [your own name here?](https://github.com/users/akyoto/sponsorship)

[godoc-image]: https://godoc.org/github.com/aerogo/packet?status.svg
[godoc-url]: https://godoc.org/github.com/aerogo/packet
[report-image]: https://goreportcard.com/badge/github.com/aerogo/packet
[report-url]: https://goreportcard.com/report/github.com/aerogo/packet
[tests-image]: https://cloud.drone.io/api/badges/aerogo/packet/status.svg
[tests-url]: https://cloud.drone.io/aerogo/packet
[coverage-image]: https://codecov.io/gh/aerogo/packet/graph/badge.svg
[coverage-url]: https://codecov.io/gh/aerogo/packet
[sponsor-image]: https://img.shields.io/badge/github-donate-green.svg
[sponsor-url]: https://github.com/users/akyoto/sponsorship


packet

Package raw enables reading and writing data at the device driver level for a network interface.

# raw [![Test Status](https://github.com/mdlayher/raw/workflows/Test/badge.svg)](https://github.com/mdlayher/raw/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/mdlayher/raw.svg)](https://pkg.go.dev/github.com/mdlayher/raw)  [![Go Report Card](https://goreportcard.com/badge/github.com/mdlayher/raw)](https://goreportcard.com/report/github.com/mdlayher/raw)

Package `raw` enables reading and writing data at the device driver level for a
network interface. MIT Licensed.

Deprecated: use
[`github.com/mdlayher/packet`](https://github.com/mdlayher/packet) on Linux
instead. This package is unmaintained.

For more information about using sockets with Ethernet frames in Go, check out
my blog post: [Network Protocol Breakdown: Ethernet and
Go](https://mdlayher.com/blog/network-protocol-breakdown-ethernet-and-go/).

## Unmaintained

This repository was one of my first major Go networking libraries. Although I
have updated it on Linux to incorporate modern Go best practices (asynchronous
I/O, runtime network poller integration), the non-Linux platform code is
effectively unmaintained and does not have the same level of functionality.

I encourage all Linux users of this package to migrate to
[`github.com/mdlayher/packet`](https://github.com/mdlayher/packet), which is a
modern `AF_PACKET` library. The existing `*raw.Conn` APIs now call directly into
the equivalent `*packet.Conn` APIs, and a level of indirection can be removed by
migrating to that package.


The Best Go Libraries For Networking - Libraries for working with various layers of the network. (2)

packet

raw