wire

type MulticastCommunicator interface {
	// Listen starts the listener loop responsible for reading messages from the
	// multicast network and sending data read to the provided delegate. This
	// method will block the current calling routine until Shutdown is called.
	Listen()

	// Write writes a given buffer to the Multicast network.
	Write(data []byte) error

	// Shutdown starts the shutdown process for the current
	// MulticastCommunicator. It is safe to call this method multiple times.
	Shutdown()
}

type MulticastCommunicatorDelegate interface {
	// LocalIPs is responsible for returning a list of all local IP addresses.
	LocalIPs() *iputil.IPList

	// HandleMulticastMessage is responsible for interpreting and handling a
	// given message received from the Multicast network.
	HandleMulticastMessage(listener MulticastCommunicator, data []byte, source net.IP)
}

type TCPControlClient interface {
	// Write writes the provided proto.TCPPacket to the client's socket
	Write(data *proto.TCPPacket) error

	// Close closes the client socket and stops all associated routines
	Close()

	// Source returns the TCP Address of the remote client
	Source() *net.TCPAddr

	// Hijack prevents incoming messages to be delivered to the default handler,
	// those being delivered instead directly to the channel returned by this
	// method.
	Hijack() chan *proto.TCPPacket
}

type TCPControlServer interface {
	// Start starts the server in a new routine.
	Start()

	// Shutdown signals the server to shut down and blocks the calling routine
	// until all clients disconnect.
	Shutdown()

	// Dial opens a new socket to a remote control server specified by addr
	Dial(addr proto.IP, port uint16) (TCPControlClient, error)
}

type TCPControlServerDelegate interface {
	HandleTCPPacket(server TCPControlServer, client TCPControlClient, tcpPkt *proto.TCPPacket)
}

type UDPControlServer interface {
	// Listen starts the server on the calling routine, blocking until it is
	// shutdown.
	Listen()

	// Shutdown signals the server to shut down, unblocking the routine that '
	// invoked Listen
	Shutdown()

	// WriteUDP writes a given data buffer to the specified address and port.
	// Returns the amount of bytes written, or an error
	WriteUDP(target *net.UDPAddr, data []byte) (int, error)
}

type UDPControlServerDelegate interface {
	HandleUDPControlMessage(server UDPControlServer, data []byte, source *net.UDPAddr)
}