ircctcp

Documentation

Overview

Package ircctcp encodes and decodes CTCP payloads and provides optional auto-replies to CTCP queries.

Index

• Constants
• func Unwrap(payload string) (cmd, args string, ok bool)
• func Wrap(command, args string) string
• type AutoReplies
  • func (a AutoReplies) Reply(command, args string) (replyArgs string, ok bool)

Constants

const Marker = "\x01"

Marker is the byte that delimits a CTCP payload.

Functions

func Unwrap

func Unwrap(payload string) (cmd, args string, ok bool)

Unwrap returns (command, args, true) if payload is a CTCP message. The command is upper-cased.

func Wrap

func Wrap(command, args string) string

Wrap encodes command and args into a CTCP payload delimited by Marker.

Types

type AutoReplies

type AutoReplies struct {
	Version    string
	Source     string
	UserInfo   string
	ClientInfo string
	Time       bool
	Ping       bool
	Finger     string
}

AutoReplies controls which CTCP queries get an automatic NOTICE response. The zero value disables all auto-replies.

func (AutoReplies) Reply

func (a AutoReplies) Reply(command, args string) (replyArgs string, ok bool)

Reply returns the reply arguments for command and reports whether an auto-reply is configured for it.