tcp

Documentation

Overview

Not to be confused with Transmission Control Protocol!

Index

• Variables
• func GetHead() (head uint32)
• func GetMessage(index uint32) (username string, content string)
• func StartServer()
• type Message
• type Packet

Variables

var (
	ListenAddr    string // Contains the IP address to listen on.
	HistoryLength int    // Contains the maximum amount of messages that will be stored.

	DiscordChannel chan []string // Channel through which messages get sent to Discord.
	TCPChannel     chan []string // Channel through which messages get sent to TCP users.
)

Functions

func GetHead

func GetHead() (head uint32)

GetHead returns the current message head.

func GetMessage

func GetMessage(index uint32) (username string, content string)

GetMessage looks up the message at the specified index and returns it if it is stored in the LRU cache.

func StartServer

func StartServer()

StartServer starts the TCP server portion of the bridge.

Types

type Message

type Message struct {
	Username string
	Content  string
}

Message represents a message. A message is made up of a sender (represented by the username) and its content.

type Packet

type Packet struct {
	Magic      [4]byte
	PacketType byte
	Payload    [1495]byte
}

Packet represents a TCP packet.