wire

Package wire implements the cryptix wire protocol.

Cryptix Message Overview

The cryptix protocol consists of exchanging messages between peers. Each message is preceded by a header which identifies information about it such as which cryptix network it is a part of, its type, how big it is, and a checksum to verify validity. All encoding and decoding of message headers is handled by this package.

To accomplish this, there is a generic interface for cryptix messages named Message which allows messages of any type to be read, written, or passed around through channels, functions, etc. In addition, concrete implementations of most all cryptix messages are provided. All of the details of marshalling and unmarshalling to and from the wire using cryptix encoding are handled so the caller doesn't have to concern themselves with the specifics.

Reading Messages Example

In order to unmarshal cryptix messages from the wire, use the ReadMessage function. It accepts any io.Reader, but typically this will be a net.Conn to a remote node running a cryptix peer. Example syntax is:

	// Use the most recent protocol version supported by the package and the
	// main cryptix network.
	pver := wire.ProtocolVersion
	cryptix-network := wire.Mainnet

	// Reads and validates the next cryptix message from conn using the
	// protocol version pver and the cryptix network cryptix-network. The returns
	// are a appmessage.Message, a []byte which contains the unmarshalled
	// raw payload, and a possible error.
	msg, rawPayload, err := wire.ReadMessage(conn, pver, cryptix-network)
	if err != nil {
		// Log and handle the error
	}

See the package documentation for details on determining the message type.

Writing Messages Example

In order to marshal cryptix messages to the wire, use the WriteMessage function. It accepts any io.Writer, but typically this will be a net.Conn to a remote node running a cryptix peer. Example syntax to request addresses from a remote peer is:

	// Use the most recent protocol version supported by the package and the
	// main bitcoin network.
	pver := wire.ProtocolVersion
	cryptix-network := wire.Mainnet

	// Create a new getaddr cryptix message.
	msg := wire.NewMsgGetAddr()

	// Writes a cryptix message msg to conn using the protocol version
	// pver, and the cryptix network cryptix-network. The return is a possible
	// error.
	err := wire.WriteMessage(conn, msg, pver, cryptix-network)
	if err != nil {
		// Log and handle the error
	}