Safe Haskell	None
Language	Haskell2010

Network.Yak.Capabilities

Contents

Invalid Capabilities
Capability Messages
- LS
- LIST
- REQ
- NEW/DEL

Description

Capability negotiation as per IRCv3 spec. Based on v3.1 http://ircv3.net/specs/core/capability-negotiation-3.1.html and v3.2 http://ircv3.net/specs/core/capability-negotiation-3.2.html.

Synopsis

type Identifier = Either (Unused "*") Text
type Subcommand = Unused
data CapModifier
- = ModDisable
- | ModAck
- | ModSticky
- | ModNone
_ModDisable :: Prism' CapModifier ()
_ModAck :: Prism' CapModifier ()
_ModSticky :: Prism' CapModifier ()
_ModNone :: Prism' CapModifier ()
data Capability = Capability CapModifier Text
modifier :: Lens' Capability CapModifier
capability :: Lens' Capability Text
data ReqAnswer
- = Ack
- | Nak
_Ack :: Prism' ReqAnswer ()
_Nak :: Prism' ReqAnswer ()
type ErrInvalidcap = Msg "410" [Identifier, Text, Message]
errInvalidcapIdentifier :: Lens' ErrInvalidcap Identifier
errInvalidcapCommand :: Lens' ErrInvalidcap Text
errInvalidcapMessage :: Lens' ErrInvalidcap Message
type CapLs = Msg "CAP LS" '[Flag "302"]
capLs302 :: Lens' CapLs (Flag "302")
type SrvCapLs = Msg "CAP" '[Identifier, Subcommand "LS", Flag "*", CList Capability]
srvCapLsIdentifier :: Lens' SrvCapLs Identifier
srvCapLsMultiLine :: Lens' SrvCapLs (Flag "*")
srvCapLsCapabilities :: Lens' SrvCapLs [Capability]
type CapList = Msg "CAP LIST" '[]
type SrvCapList = Msg "CAP" '[Identifier, Subcommand "LIST", Flag "*", CList Capability]
srvCapListIdentifier :: Lens' SrvCapList Identifier
srvCapListMultiLine :: Lens' SrvCapList (Flag "*")
srvCapListCapabilities :: Lens' SrvCapList [Capability]
type CapReq = Msg "CAP REQ" '[CList Capability]
capReqCapabilities :: Lens' CapReq [Capability]
type SrvCapReq = Msg "CAP" '[Identifier, ReqAnswer, CList Capability]
srvCapReqIdentifier :: Lens' SrvCapReq Identifier
srvCapReqAnswer :: Lens' SrvCapReq ReqAnswer
srvCapReqCapabilities :: Lens' SrvCapReq [Capability]
type CapAck = Msg "CAP ACK" '[CList Capability]
capAckCapabilities :: Lens' CapAck [Capability]
type CapEnd = Msg "CAP END" '[]
type SrvCapNew = Msg "CAP" '[Identifier, Subcommand "NEW", CList Capability]
srvCapNewIdentifier :: Lens' SrvCapNew Identifier
srvCapNewCapabilities :: Lens' SrvCapNew [Capability]
type SrvCapDel = Msg "CAP" '[Identifier, Subcommand "DEL", CList Capability]
srvCapDelIdentifier :: Lens' SrvCapDel Identifier
srvCapDelCapabilities :: Lens' SrvCapDel [Capability]

Documentation

type Identifier = Either (Unused "*") Text Source #

type Subcommand = Unused Source #

data CapModifier Source #

Constructors

ModDisable
ModAck	Deprecated as of v3.2
ModSticky	Deprecated as of v3.2
ModNone

Instances

Eq CapModifier Source #
Instance details Defined in Network.Yak.Capabilities Methods (==) :: CapModifier -> CapModifier -> Bool # (/=) :: CapModifier -> CapModifier -> Bool #
Ord CapModifier Source #
Instance details Defined in Network.Yak.Capabilities Methods compare :: CapModifier -> CapModifier -> Ordering # (<) :: CapModifier -> CapModifier -> Bool # (<=) :: CapModifier -> CapModifier -> Bool # (>) :: CapModifier -> CapModifier -> Bool # (>=) :: CapModifier -> CapModifier -> Bool # max :: CapModifier -> CapModifier -> CapModifier # min :: CapModifier -> CapModifier -> CapModifier #
Read CapModifier Source #
Instance details Defined in Network.Yak.Capabilities Methods readsPrec :: Int -> ReadS CapModifier # readList :: ReadS [CapModifier] # readPrec :: ReadPrec CapModifier # readListPrec :: ReadPrec [CapModifier] #
Show CapModifier Source #
Instance details Defined in Network.Yak.Capabilities Methods showsPrec :: Int -> CapModifier -> ShowS # show :: CapModifier -> String # showList :: [CapModifier] -> ShowS #

_ModDisable :: Prism' CapModifier () Source #

_ModAck :: Prism' CapModifier () Source #

_ModSticky :: Prism' CapModifier () Source #

_ModNone :: Prism' CapModifier () Source #

data Capability Source #

Constructors

Capability CapModifier Text

Instances

Eq Capability Source #
Instance details Defined in Network.Yak.Capabilities Methods (==) :: Capability -> Capability -> Bool # (/=) :: Capability -> Capability -> Bool #
Ord Capability Source #
Instance details Defined in Network.Yak.Capabilities Methods compare :: Capability -> Capability -> Ordering # (<) :: Capability -> Capability -> Bool # (<=) :: Capability -> Capability -> Bool # (>) :: Capability -> Capability -> Bool # (>=) :: Capability -> Capability -> Bool # max :: Capability -> Capability -> Capability # min :: Capability -> Capability -> Capability #
Read Capability Source #
Instance details Defined in Network.Yak.Capabilities Methods readsPrec :: Int -> ReadS Capability # readList :: ReadS [Capability] # readPrec :: ReadPrec Capability # readListPrec :: ReadPrec [Capability] #
Show Capability Source #
Instance details Defined in Network.Yak.Capabilities Methods showsPrec :: Int -> Capability -> ShowS # show :: Capability -> String # showList :: [Capability] -> ShowS #
Parameter Capability Source #
Instance details Defined in Network.Yak.Capabilities Methods render :: Capability -> ByteString Source # seize :: Parser Capability Source #

modifier :: Lens' Capability CapModifier Source #

capability :: Lens' Capability Text Source #

data ReqAnswer Source #

A REQ (CapReq, SrvCapReq), can be answered either with an ACK or a NAK.

Constructors

Ack
Nak

Instances

Eq ReqAnswer Source #
Instance details Defined in Network.Yak.Capabilities Methods (==) :: ReqAnswer -> ReqAnswer -> Bool # (/=) :: ReqAnswer -> ReqAnswer -> Bool #
Ord ReqAnswer Source #
Instance details Defined in Network.Yak.Capabilities Methods compare :: ReqAnswer -> ReqAnswer -> Ordering # (<) :: ReqAnswer -> ReqAnswer -> Bool # (<=) :: ReqAnswer -> ReqAnswer -> Bool # (>) :: ReqAnswer -> ReqAnswer -> Bool # (>=) :: ReqAnswer -> ReqAnswer -> Bool # max :: ReqAnswer -> ReqAnswer -> ReqAnswer # min :: ReqAnswer -> ReqAnswer -> ReqAnswer #
Read ReqAnswer Source #
Instance details Defined in Network.Yak.Capabilities Methods readsPrec :: Int -> ReadS ReqAnswer # readList :: ReadS [ReqAnswer] # readPrec :: ReadPrec ReqAnswer # readListPrec :: ReadPrec [ReqAnswer] #
Show ReqAnswer Source #
Instance details Defined in Network.Yak.Capabilities Methods showsPrec :: Int -> ReqAnswer -> ShowS # show :: ReqAnswer -> String # showList :: [ReqAnswer] -> ShowS #
Parameter ReqAnswer Source #
Instance details Defined in Network.Yak.Capabilities Methods render :: ReqAnswer -> ByteString Source # seize :: Parser ReqAnswer Source #

_Ack :: Prism' ReqAnswer () Source #

_Nak :: Prism' ReqAnswer () Source #

Invalid Capabilities

type ErrInvalidcap = Msg "410" [Identifier, Text, Message] Source #

410 * <command> :Invalid CAP command

errInvalidcapIdentifier :: Lens' ErrInvalidcap Identifier Source #

errInvalidcapCommand :: Lens' ErrInvalidcap Text Source #

errInvalidcapMessage :: Lens' ErrInvalidcap Message Source #

Capability Messages

LS

type CapLs = Msg "CAP LS" '[Flag "302"] Source #

The LS subcommand is used to list the capabilities supported by the server. The client should send an LS subcommand with no other arguments to solicit a list of all capabilities.

Since v3.2, LS can be invoked with a 302 flag.

capLs302 :: Lens' CapLs (Flag "302") Source #

type SrvCapLs = Msg "CAP" '[Identifier, Subcommand "LS", Flag "*", CList Capability] Source #

All but the last line in multi-line responses must have the * enabled.

srvCapLsIdentifier :: Lens' SrvCapLs Identifier Source #

srvCapLsMultiLine :: Lens' SrvCapLs (Flag "*") Source #

srvCapLsCapabilities :: Lens' SrvCapLs [Capability] Source #

LIST

type CapList = Msg "CAP LIST" '[] Source #

The LIST subcommand is used to list the capabilities associated with the active connection. The client should send a LIST subcommand with no other arguments to solicit a list of active capabilities. If no capabilities are active, an empty parameter must be sent.

type SrvCapList = Msg "CAP" '[Identifier, Subcommand "LIST", Flag "*", CList Capability] Source #

All but the last line in multi-line responses must have the * enabled.

srvCapListIdentifier :: Lens' SrvCapList Identifier Source #

srvCapListMultiLine :: Lens' SrvCapList (Flag "*") Source #

srvCapListCapabilities :: Lens' SrvCapList [Capability] Source #

REQ

type CapReq = Msg "CAP REQ" '[CList Capability] Source #

The REQ subcommand is used to request a change in capabilities associated with the active connection. It’s sole parameter must be a list of space-separated capability identifiers. Each capability identifier may be prefixed with a dash (-) to designate that the capability should be disabled.

capReqCapabilities :: Lens' CapReq [Capability] Source #

type SrvCapReq = Msg "CAP" '[Identifier, ReqAnswer, CList Capability] Source #

srvCapReqIdentifier :: Lens' SrvCapReq Identifier Source #

srvCapReqAnswer :: Lens' SrvCapReq ReqAnswer Source #

srvCapReqCapabilities :: Lens' SrvCapReq [Capability] Source #

type CapAck = Msg "CAP ACK" '[CList Capability] Source #

Client side ACK.

capAckCapabilities :: Lens' CapAck [Capability] Source #

type CapEnd = Msg "CAP END" '[] Source #

The END subcommand signals to the server that capability negotiation is complete and requests that the server continue with client registration.

NEW/DEL

type SrvCapNew = Msg "CAP" '[Identifier, Subcommand "NEW", CList Capability] Source #

srvCapNewIdentifier :: Lens' SrvCapNew Identifier Source #

srvCapNewCapabilities :: Lens' SrvCapNew [Capability] Source #

type SrvCapDel = Msg "CAP" '[Identifier, Subcommand "DEL", CList Capability] Source #

srvCapDelIdentifier :: Lens' SrvCapDel Identifier Source #

srvCapDelCapabilities :: Lens' SrvCapDel [Capability] Source #