Safe Haskell	None
Language	Haskell2010

Network.Yak.Client

Contents

Connection Messages
Channel Operations
Server Queries and Commands
Sending Messages
User-based queries
Optional Messages
Miscellaneous Messages
Extras
Common Accessors

Description

Messages for IRC Clients, implementing the current "living standard", to be found at https://modern.ircdocs.horse/. This module does not include the responses. See Network.Yak.Response for standard-compliant responses.

Synopsis

type Authenticate = Msg "AUTHENTICATE" '[Text]
authenticateArgument :: Lens' Authenticate Text
type Pass = Msg "PASS" '[Text]
passPassword :: Lens' Pass Text
type Nick = Msg "NICK" '[Nickname]
nickNickname :: Lens' Nick Nickname
type User = Msg "USER" '[Username, Word, Unused "*", Message]
userUsername :: Lens' User Username
userMode :: Lens' User Word
userUnused :: Lens' User (Unused "*")
userRealname :: Lens' User Message
type Oper = Msg "OPER" '[Nickname, Text]
operName :: Lens' Oper Nickname
operPassword :: Lens' Oper Text
type Quit = Msg "QUIT" '[Message]
quitMessage :: Lens' Quit Message
type Join = Msg "JOIN" '[NonEmpty Channel, [Text]]
type Join0 = Msg "JOIN" '[Unused "0"]
joinChannels :: Lens' Join (NonEmpty Channel)
joinKeys :: Lens' Join [Text]
type Part = Msg "PART" '[NonEmpty Channel, Maybe Message]
partChannels :: Lens' Part (NonEmpty Channel)
partMessage :: Lens' Part (Maybe Message)
type Topic = Msg "TOPIC" '[Channel, Maybe Message]
topicChannel :: Lens' Topic Channel
topicMessage :: Lens' Topic (Maybe Message)
type Names = Msg "NAMES" '[[Channel]]
namesChannels :: Lens' Names [Channel]
type List = Msg "LIST" '[[Channel], Maybe Text]
listChannels :: Lens' List [Channel]
listElistCond :: Lens' List (Maybe Text)
type Motd = Msg "MOTD" '[Hostname]
motdTarget :: Lens' Motd Hostname
type Lusers = Msg "LUSERS" '[Maybe (Mask, Maybe Hostname)]
lusersParam :: Lens' Lusers (Maybe (Mask, Maybe Hostname))
lusersMask :: Traversal' Lusers Mask
lusersTarget :: Traversal' Lusers Hostname
type Version = Msg "VERSION" '[Maybe Hostname]
versionTarget :: Lens' Version (Maybe Hostname)
type Admin = Msg "ADMIN" '[Maybe Hostname]
adminTarget :: Lens' Admin (Maybe Hostname)
type Connect = Msg "CONNECT" '[Hostname, Maybe (Int, Maybe Hostname)]
connectTarget :: Lens' Connect Hostname
connectConnInfo :: Lens' Connect (Maybe (Int, Maybe Hostname))
type Time = Msg "TIME" '[Maybe Hostname]
timeTarget :: Lens' Time (Maybe Hostname)
type Stats = Msg "STATS" '[Char, Maybe Hostname]
statsQuery :: Lens' Stats Char
statsTarget :: Lens' Stats (Maybe Hostname)
type Info = Msg "INFO" '[Maybe Hostname]
infoTarget :: Lens' Info (Maybe Hostname)
type Mode = Msg "MODE" '[Either Channel Nickname, Maybe ByteString]
modeTarget :: Lens' Mode (Either Channel Nickname)
modeSetter :: Lens' Mode (Maybe ByteString)
modeChannel :: Traversal' Mode Channel
modeNick :: Traversal' Mode Nickname
modeString :: ServerModes -> Fold Mode ModeStr
type Privmsg = Msg "PRIVMSG" '[NonEmpty (Either Channel Nickname), Message]
privmsgTargets :: Lens' Privmsg (NonEmpty (Either Channel Nickname))
privmsgMessage :: Lens' Privmsg Message
privmsgChannel :: Traversal' Privmsg Channel
privmsgNick :: Traversal' Privmsg Nickname
type Notice = Msg "NOTICE" '[NonEmpty (Either Channel Nickname), Message]
noticeTargets :: Lens' Notice (NonEmpty (Either Channel Nickname))
noticeMessage :: Lens' Notice Message
noticeChannel :: Traversal' Notice Channel
noticeNick :: Traversal' Notice Nickname
type Who = Msg "WHO" '[Maybe Mask, Flag "o"]
whoMask :: Lens' Who (Maybe Mask)
whoFlag :: Lens' Who (Flag "o")
type WhoIs = Msg "WHOIS" '[Maybe Hostname, NonEmpty Mask]
whoIsTarget :: Lens' WhoIs (Maybe Hostname)
whoIsMasks :: Lens' WhoIs (NonEmpty Mask)
type WhoWas = Msg "WHOWAS" '[NonEmpty Nickname, Maybe (Int, Maybe Hostname)]
whoWasNicks :: Lens' WhoWas (NonEmpty Nickname)
whoWasParam :: Lens' WhoWas (Maybe (Int, Maybe Hostname))
whoWasCount :: Traversal' WhoWas Int
whoWasTarget :: Traversal' WhoWas Hostname
type Userhost = Msg "USERHOST" '[Nickname, Maybe Nickname, Maybe Nickname, Maybe Nickname, Maybe Nickname]
userhostNick1 :: Lens' Userhost Nickname
userhostNick2 :: Lens' Userhost (Maybe Nickname)
userhostNick3 :: Lens' Userhost (Maybe Nickname)
userhostNick4 :: Lens' Userhost (Maybe Nickname)
userhostNick5 :: Lens' Userhost (Maybe Nickname)
type Ping = Msg "PING" '[Hostname, Maybe Hostname]
pingServer1 :: Lens' Ping Hostname
pingServer2 :: Lens' Ping (Maybe Hostname)
type Pong = Msg "PONG" '[Hostname, Maybe Hostname]
pongServer1 :: Lens' Pong Hostname
pongServer2 :: Lens' Pong (Maybe Hostname)
type Kill = Msg "KILL" '[Nickname, Message]
killNick :: Lens' Kill Nickname
killMessage :: Lens' Kill Message
type Kick = Msg "KICK" '[NonEmpty Channel, NonEmpty Nickname, Maybe Message]
kickChannels :: Lens' Kick (NonEmpty Channel)
kickNicknames :: Lens' Kick (NonEmpty Nickname)
kickMessage :: Lens' Kick (Maybe Message)
type Invite = Msg "INVITE" '[Nickname, Channel]
inviteNickname :: Lens' Invite Nickname
inviteChannel :: Lens' Invite Channel
class HasChannel a where
- channel :: Traversal' a Channel
class HasNick a where
- nick :: Traversal' a Nickname
class HasHostname a where
- hostname :: Traversal' a Hostname

Connection Messages

type Authenticate = Msg "AUTHENTICATE" '[Text] Source #

AUTHENTICATE

authenticateArgument :: Lens' Authenticate Text Source #

type Pass = Msg "PASS" '[Text] Source #

PASS <password>

passPassword :: Lens' Pass Text Source #

type Nick = Msg "NICK" '[Nickname] Source #

NICK <nickname>

nickNickname :: Lens' Nick Nickname Source #

type User = Msg "USER" '[Username, Word, Unused "*", Message] Source #

USER <username> 0 * <realname>

userUsername :: Lens' User Username Source #

userMode :: Lens' User Word Source #

userUnused :: Lens' User (Unused "*") Source #

userRealname :: Lens' User Message Source #

type Oper = Msg "OPER" '[Nickname, Text] Source #

OPER <name> <password>

operName :: Lens' Oper Nickname Source #

operPassword :: Lens' Oper Text Source #

type Quit = Msg "QUIT" '[Message] Source #

QUIT [<reason>]

quitMessage :: Lens' Quit Message Source #

Channel Operations

type Join = Msg "JOIN" '[NonEmpty Channel, [Text]] Source #

JOIN <channel>{,<channel>} [<key>{,<key>}]

type Join0 = Msg "JOIN" '[Unused "0"] Source #

joinChannels :: Lens' Join (NonEmpty Channel) Source #

joinKeys :: Lens' Join [Text] Source #

type Part = Msg "PART" '[NonEmpty Channel, Maybe Message] Source #

PART <channel>{,<channel>} [<reason>]

partChannels :: Lens' Part (NonEmpty Channel) Source #

partMessage :: Lens' Part (Maybe Message) Source #

type Topic = Msg "TOPIC" '[Channel, Maybe Message] Source #

TOPIC <channel> [<topic>]

topicChannel :: Lens' Topic Channel Source #

topicMessage :: Lens' Topic (Maybe Message) Source #

type Names = Msg "NAMES" '[[Channel]] Source #

NAMES [<channel>{,<channel>}]

namesChannels :: Lens' Names [Channel] Source #

type List = Msg "LIST" '[[Channel], Maybe Text] Source #

LIST [<channel>{,<channel>}] [<elistcond>{,<elistcond>}]

listChannels :: Lens' List [Channel] Source #

listElistCond :: Lens' List (Maybe Text) Source #

Server Queries and Commands

type Motd = Msg "MOTD" '[Hostname] Source #

MOTD [<target>]

motdTarget :: Lens' Motd Hostname Source #

type Lusers = Msg "LUSERS" '[Maybe (Mask, Maybe Hostname)] Source #

LUSERS [<mask> [<target>]]

lusersParam :: Lens' Lusers (Maybe (Mask, Maybe Hostname)) Source #

lusersMask :: Traversal' Lusers Mask Source #

lusersTarget :: Traversal' Lusers Hostname Source #

type Version = Msg "VERSION" '[Maybe Hostname] Source #

VERSION [<target>]

versionTarget :: Lens' Version (Maybe Hostname) Source #

type Admin = Msg "ADMIN" '[Maybe Hostname] Source #

ADMIN [<target>]

adminTarget :: Lens' Admin (Maybe Hostname) Source #

type Connect = Msg "CONNECT" '[Hostname, Maybe (Int, Maybe Hostname)] Source #

CONNECT <target server> [<port> [<remote server>]]

connectTarget :: Lens' Connect Hostname Source #

connectConnInfo :: Lens' Connect (Maybe (Int, Maybe Hostname)) Source #

type Time = Msg "TIME" '[Maybe Hostname] Source #

TIME [<server>]

timeTarget :: Lens' Time (Maybe Hostname) Source #

type Stats = Msg "STATS" '[Char, Maybe Hostname] Source #

STATS <query> [<server>]

statsQuery :: Lens' Stats Char Source #

statsTarget :: Lens' Stats (Maybe Hostname) Source #

type Info = Msg "INFO" '[Maybe Hostname] Source #

INFO [<target>]

infoTarget :: Lens' Info (Maybe Hostname) Source #

type Mode = Msg "MODE" '[Either Channel Nickname, Maybe ByteString] Source #

MODE <target> [<modestring> [<mode arguments>...]]

modeTarget :: Lens' Mode (Either Channel Nickname) Source #

modeSetter :: Lens' Mode (Maybe ByteString) Source #

modeChannel :: Traversal' Mode Channel Source #

modeNick :: Traversal' Mode Nickname Source #

modeString :: ServerModes -> Fold Mode ModeStr Source #

Sending Messages

type Privmsg = Msg "PRIVMSG" '[NonEmpty (Either Channel Nickname), Message] Source #

PRIVMSG <target>{,<target>} <text to be sent>

privmsgTargets :: Lens' Privmsg (NonEmpty (Either Channel Nickname)) Source #

privmsgMessage :: Lens' Privmsg Message Source #

privmsgChannel :: Traversal' Privmsg Channel Source #

privmsgNick :: Traversal' Privmsg Nickname Source #

type Notice = Msg "NOTICE" '[NonEmpty (Either Channel Nickname), Message] Source #

NOTICE <target>{,<target>} <text to be sent>

noticeTargets :: Lens' Notice (NonEmpty (Either Channel Nickname)) Source #

noticeMessage :: Lens' Notice Message Source #

noticeChannel :: Traversal' Notice Channel Source #

noticeNick :: Traversal' Notice Nickname Source #

User-based queries

type Who = Msg "WHO" '[Maybe Mask, Flag "o"] Source #

WHO [<mask>] [o]

whoMask :: Lens' Who (Maybe Mask) Source #

whoFlag :: Lens' Who (Flag "o") Source #

type WhoIs = Msg "WHOIS" '[Maybe Hostname, NonEmpty Mask] Source #

WHOIS [<target>] <mask>{,<mask>}

whoIsTarget :: Lens' WhoIs (Maybe Hostname) Source #

whoIsMasks :: Lens' WhoIs (NonEmpty Mask) Source #

type WhoWas = Msg "WHOWAS" '[NonEmpty Nickname, Maybe (Int, Maybe Hostname)] Source #

WHOWAS <nickname>{,<nickname} [<count>, [<target>]]

whoWasNicks :: Lens' WhoWas (NonEmpty Nickname) Source #

whoWasParam :: Lens' WhoWas (Maybe (Int, Maybe Hostname)) Source #

whoWasCount :: Traversal' WhoWas Int Source #

whoWasTarget :: Traversal' WhoWas Hostname Source #

Optional Messages

type Userhost = Msg "USERHOST" '[Nickname, Maybe Nickname, Maybe Nickname, Maybe Nickname, Maybe Nickname] Source #

USERHOST <nickname>{ <nickname>}

userhostNick1 :: Lens' Userhost Nickname Source #

userhostNick2 :: Lens' Userhost (Maybe Nickname) Source #

userhostNick3 :: Lens' Userhost (Maybe Nickname) Source #

userhostNick4 :: Lens' Userhost (Maybe Nickname) Source #

userhostNick5 :: Lens' Userhost (Maybe Nickname) Source #

Miscellaneous Messages

type Ping = Msg "PING" '[Hostname, Maybe Hostname] Source #

PING <server1> [<server2>]

pingServer1 :: Lens' Ping Hostname Source #

pingServer2 :: Lens' Ping (Maybe Hostname) Source #

type Pong = Msg "PONG" '[Hostname, Maybe Hostname] Source #

PONG <server1> [<server2>]

pongServer1 :: Lens' Pong Hostname Source #

pongServer2 :: Lens' Pong (Maybe Hostname) Source #

type Kill = Msg "KILL" '[Nickname, Message] Source #

KILL <nickname> <comment>

killNick :: Lens' Kill Nickname Source #

killMessage :: Lens' Kill Message Source #

Extras

Common messages that are not specified out in the document above.

type Kick = Msg "KICK" '[NonEmpty Channel, NonEmpty Nickname, Maybe Message] Source #

KICK <channel>(,<channel>)* <nickname>(,<nickname>)* [message]

As defined in RFC 2812

kickChannels :: Lens' Kick (NonEmpty Channel) Source #

kickNicknames :: Lens' Kick (NonEmpty Nickname) Source #

kickMessage :: Lens' Kick (Maybe Message) Source #

type Invite = Msg "INVITE" '[Nickname, Channel] Source #

INVITE <nickname> <channel>

As defined in RFC 2812

inviteNickname :: Lens' Invite Nickname Source #

inviteChannel :: Lens' Invite Channel Source #

Common Accessors

class HasChannel a where Source #

Class for extracting the channel out of messages that may contain channels

Methods

channel :: Traversal' a Channel Source #

Instances

HasChannel Join Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Join Channel Source #
HasChannel Part Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Part Channel Source #
HasChannel Topic Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Topic Channel Source #
HasChannel Names Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Names Channel Source #
HasChannel List Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' List Channel Source #
HasChannel Mode Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Mode Channel Source #
HasChannel Privmsg Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Privmsg Channel Source #
HasChannel Notice Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Notice Channel Source #
HasChannel Kick Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Kick Channel Source #
HasChannel Invite Source #
Instance details Defined in Network.Yak.Client Methods channel :: Traversal' Invite Channel Source #

class HasNick a where Source #

Messages containing a nickname in one (unambigious) position.

Methods

nick :: Traversal' a Nickname Source #

Instances

HasNick Nick Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Nick Nickname Source #
HasNick Oper Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Oper Nickname Source #
HasNick Mode Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Mode Nickname Source #
HasNick Privmsg Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Privmsg Nickname Source #
HasNick Notice Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Notice Nickname Source #
HasNick WhoWas Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' WhoWas Nickname Source #
HasNick Kill Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Kill Nickname Source #
HasNick Kick Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Kick Nickname Source #
HasNick Invite Source #
Instance details Defined in Network.Yak.Client Methods nick :: Traversal' Invite Nickname Source #

class HasHostname a where Source #

Messages containing a hostname in one (unambigious) position

Methods

hostname :: Traversal' a Hostname Source #

Instances

HasHostname Motd Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' Motd Hostname Source #
HasHostname Lusers Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' Lusers Hostname Source #
HasHostname Version Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' Version Hostname Source #
HasHostname Admin Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' Admin Hostname Source #
HasHostname Time Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' Time Hostname Source #
HasHostname Stats Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' Stats Hostname Source #
HasHostname Info Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' Info Hostname Source #
HasHostname WhoIs Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' WhoIs Hostname Source #
HasHostname WhoWas Source #
Instance details Defined in Network.Yak.Client Methods hostname :: Traversal' WhoWas Hostname Source #