common

Documentation

Overview

Copyright (c) 2014, SamLex (Euan James Hunter) All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of mcudpt nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• func CheckErr(message string, err error)
• func WaitForInterrupt()
• type Tunnel
  • func NewTunnel(reader io.Reader, writer io.Writer) (t *Tunnel)
  • func (t *Tunnel) Read() (tm *TunnelMessage, err error)
  • func (t *Tunnel) SetMessageReceiveFunc(f func(tm *TunnelMessage))
  • func (t *Tunnel) Start()
  • func (t *Tunnel) Write(tm *TunnelMessage) (err error)
• type TunnelMessage
  • func NewTunnelMessage(pm *TunnelPacketMessage) (tm *TunnelMessage)
• type TunnelPacketMessage
  • func NewTunnelPacketMessage() (pm *TunnelPacketMessage)

Functions

func CheckErr

func CheckErr(message string, err error)

Check for an error, log and die if there is one

func WaitForInterrupt

func WaitForInterrupt()

Waits for an interrupt (Ctrl+C) then returns

Types

type Tunnel

type Tunnel struct {
	// contains filtered or unexported fields
}

Tunnel used to pass UDP packets between reciever and sender

func NewTunnel

func NewTunnel(reader io.Reader, writer io.Writer) (t *Tunnel)

Create new Tunnel

func (*Tunnel) Read

func (t *Tunnel) Read() (tm *TunnelMessage, err error)

Read message from tunnel

func (*Tunnel) SetMessageReceiveFunc

func (t *Tunnel) SetMessageReceiveFunc(f func(tm *TunnelMessage))

Set a handler to handle incoming messages

func (*Tunnel) Start

func (t *Tunnel) Start()

Starts handling tunnel traffic. Returns instantly

func (*Tunnel) Write

func (t *Tunnel) Write(tm *TunnelMessage) (err error)

Write given message to tunnel

type TunnelMessage

type TunnelMessage struct {
	PacketMessage *TunnelPacketMessage
}

Meta message

func NewTunnelMessage

func NewTunnelMessage(pm *TunnelPacketMessage) (tm *TunnelMessage)

Creates new tunnel message, with embedded packet message

type TunnelPacketMessage

type TunnelPacketMessage struct {
	Host   string
	Packet []byte
}

UDP tunnling message

func NewTunnelPacketMessage

func NewTunnelPacketMessage() (pm *TunnelPacketMessage)

Creates new packet message