Copyright	(c) 2017-2019 Jack Kelly
License	GPL-3.0-or-later
Maintainer	jack@jackkelly.name
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Network.Telnet.LibTelnet.Types

Description

Wrappers for libtelnet types, where the wrapping is simple enough to not need its own module. Interpret-as-command codes live in Network.Telnet.LibTelnet.Iac, and telnet option codes live in Network.Telnet.LibTelnet.Options.

Synopsis

data TelnetT
data TelnetException
- = NullTelnetPtr
- | UnexpectedEventType TelnetEventTypeT
- | UnexpectedEnvironCmd ECmd
- | UnexpectedEnvironVar EVar
- | UnexpectedTerminalTypeCmd TCmd
newtype Flag = Flag {
- unFlag :: CUChar
}
flagProxy :: Flag
data TelnetTeloptT = TelnetTeloptT {
- _telopt :: CShort
- _us :: Iac
- _him :: Iac
}
data EventT
- = Data (CString, CSize)
- | Send (CString, CSize)
- | Warning ErrorT
- | Error ErrorT
- | Command Iac
- | Will Option
- | Wont Option
- | Do Option
- | Dont Option
- | Subnegotiation Option (CString, CSize)
- | Zmp (Ptr CString, CSize)
- | TerminalType TCmd CString
- | Compress CUChar
- | Environ ECmd (Ptr TelnetEnvironT, CSize)
- | Mssp (Ptr TelnetEnvironT, CSize)
newtype TelnetEventTypeT = TelnetEventTypeT {
- unTelnetEventTypeT :: CInt
}
eventData :: TelnetEventTypeT
eventSend :: TelnetEventTypeT
eventIac :: TelnetEventTypeT
eventWill :: TelnetEventTypeT
eventWont :: TelnetEventTypeT
eventDo :: TelnetEventTypeT
eventDont :: TelnetEventTypeT
eventSubnegotiation :: TelnetEventTypeT
eventCompress :: TelnetEventTypeT
eventZmp :: TelnetEventTypeT
eventTType :: TelnetEventTypeT
data ErrorT = ErrorT {
- _file :: CString
- _func :: CString
- _msg :: CString
- _line :: CInt
- _errcode :: TelnetErrorT
}
eventEnviron :: TelnetEventTypeT
eventMssp :: TelnetEventTypeT
eventWarning :: TelnetEventTypeT
eventError :: TelnetEventTypeT
newtype TelnetErrorT = TelnetErrorT {
- unTelnetErrorT :: CInt
}
errOK :: TelnetErrorT
errBadVal :: TelnetErrorT
errNoMem :: TelnetErrorT
errOverflow :: TelnetErrorT
errProtocol :: TelnetErrorT
errCompress :: TelnetErrorT
newtype TCmd = TCmd {
- unTCmd :: CUChar
}
tCmdIs :: TCmd
tCmdSend :: TCmd
newtype ECmd = ECmd {
- unECmd :: CUChar
}
eCmdIs :: ECmd
eCmdSend :: ECmd
eCmdInfo :: ECmd
newtype EVar = EVar {
- unEvar :: CUChar
}
eVar :: EVar
eValue :: EVar
eUserVar :: EVar
newtype MsspVar = MsspVar {
- unMsspVar :: CUChar
}
msspVar :: MsspVar
msspVal :: MsspVar
data TelnetEnvironT = TelnetEnvironT {
- _type :: EVar
- _var :: CString
- _value :: CString
}

Documentation

data TelnetT Source #

Uninhabited type for pointer safety (telnet_t).

Instances

HasTelnetPtr TelnetPtr Source #	No unwrapping needed.
Instance details Defined in Network.Telnet.LibTelnet Methods withTelnetPtr :: TelnetPtr -> (TelnetPtr -> IO a) -> IO a Source #
HasTelnetPtr Telnet Source #	Unwrap with `withForeignPtr`.
Instance details Defined in Network.Telnet.LibTelnet Methods withTelnetPtr :: Telnet -> (TelnetPtr -> IO a) -> IO a Source #

data TelnetException Source #

Exceptions thrown by the binding, for when something has gone seriously wrong. Errors detected by libtelnet are not thrown but instead are passed to the event handler.

Constructors

NullTelnetPtr
UnexpectedEventType TelnetEventTypeT
UnexpectedEnvironCmd ECmd
UnexpectedEnvironVar EVar
UnexpectedTerminalTypeCmd TCmd

Instances

Eq TelnetException Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods (==) :: TelnetException -> TelnetException -> Bool # (/=) :: TelnetException -> TelnetException -> Bool #
Show TelnetException Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods showsPrec :: Int -> TelnetException -> ShowS # show :: TelnetException -> String # showList :: [TelnetException] -> ShowS #
Generic TelnetException Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Associated Types type Rep TelnetException :: Type -> Type # Methods from :: TelnetException -> Rep TelnetException x # to :: Rep TelnetException x -> TelnetException #
Exception TelnetException Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods toException :: TelnetException -> SomeException # fromException :: SomeException -> Maybe TelnetException # displayException :: TelnetException -> String #
type Rep TelnetException Source #
Instance details Defined in Network.Telnet.LibTelnet.Types type Rep TelnetException = D1 (MetaData "TelnetException" "Network.Telnet.LibTelnet.Types" "libtelnet-0.1.0.0-FZXraNOtRYpGr85da3Gc4W" False) ((C1 (MetaCons "NullTelnetPtr" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UnexpectedEventType" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TelnetEventTypeT))) :+: (C1 (MetaCons "UnexpectedEnvironCmd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ECmd)) :+: (C1 (MetaCons "UnexpectedEnvironVar" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 EVar)) :+: C1 (MetaCons "UnexpectedTerminalTypeCmd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TCmd)))))

newtype Flag Source #

Flags for telnet_init.

Constructors

Flag
Fields unFlag :: CUChar

flagProxy :: Flag Source #

data TelnetTeloptT Source #

Wraps telnet_telopt_t.

Constructors

TelnetTeloptT
Fields _telopt :: CShort option value _us :: Iac option supported on server _him :: Iac allow clients to use the option?

Instances

Storable TelnetTeloptT Source #

Instance details

Defined in Network.Telnet.LibTelnet.Types

Methods

sizeOf :: TelnetTeloptT -> Int #

alignment :: TelnetTeloptT -> Int #

peekElemOff :: Ptr TelnetTeloptT -> Int -> IO TelnetTeloptT #

pokeElemOff :: Ptr TelnetTeloptT -> Int -> TelnetTeloptT -> IO () #

peekByteOff :: Ptr b -> Int -> IO TelnetTeloptT #

pokeByteOff :: Ptr b -> Int -> TelnetTeloptT -> IO () #

peek :: Ptr TelnetTeloptT -> IO TelnetTeloptT #

poke :: Ptr TelnetTeloptT -> TelnetTeloptT -> IO () #

data EventT Source #

Wraps telnet_event_t.

Constructors

Data (CString, CSize)	`eventData`
Send (CString, CSize)	`eventSend`
Warning ErrorT	`eventWarning`
Error ErrorT	`eventError`
Command Iac	`eventIac`
Will Option	`eventWill`
Wont Option	`eventWont`
Do Option	`eventDo`
Dont Option	`eventDont`
Subnegotiation Option (CString, CSize)	`eventSubnegotiation`
Zmp (Ptr CString, CSize)	`eventZmp`
TerminalType TCmd CString	`eventTType`
Compress CUChar	`eventCompress`
Environ ECmd (Ptr TelnetEnvironT, CSize)	`eventEnviron`
Mssp (Ptr TelnetEnvironT, CSize)	`eventMssp`

Instances

Storable EventT Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods sizeOf :: EventT -> Int # alignment :: EventT -> Int # peekElemOff :: Ptr EventT -> Int -> IO EventT # pokeElemOff :: Ptr EventT -> Int -> EventT -> IO () # peekByteOff :: Ptr b -> Int -> IO EventT # pokeByteOff :: Ptr b -> Int -> EventT -> IO () # peek :: Ptr EventT -> IO EventT # poke :: Ptr EventT -> EventT -> IO () #

newtype TelnetEventTypeT Source #

Constants from telnet_event_type_t.

Constructors

TelnetEventTypeT
Fields unTelnetEventTypeT :: CInt

Instances

Eq TelnetEventTypeT Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods (==) :: TelnetEventTypeT -> TelnetEventTypeT -> Bool # (/=) :: TelnetEventTypeT -> TelnetEventTypeT -> Bool #
Show TelnetEventTypeT Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods showsPrec :: Int -> TelnetEventTypeT -> ShowS # show :: TelnetEventTypeT -> String # showList :: [TelnetEventTypeT] -> ShowS #
Storable TelnetEventTypeT Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods sizeOf :: TelnetEventTypeT -> Int # alignment :: TelnetEventTypeT -> Int # peekElemOff :: Ptr TelnetEventTypeT -> Int -> IO TelnetEventTypeT # pokeElemOff :: Ptr TelnetEventTypeT -> Int -> TelnetEventTypeT -> IO () # peekByteOff :: Ptr b -> Int -> IO TelnetEventTypeT # pokeByteOff :: Ptr b -> Int -> TelnetEventTypeT -> IO () # peek :: Ptr TelnetEventTypeT -> IO TelnetEventTypeT # poke :: Ptr TelnetEventTypeT -> TelnetEventTypeT -> IO () #

eventData :: TelnetEventTypeT Source #

eventSend :: TelnetEventTypeT Source #

eventIac :: TelnetEventTypeT Source #

eventWill :: TelnetEventTypeT Source #

eventWont :: TelnetEventTypeT Source #

eventDo :: TelnetEventTypeT Source #

eventDont :: TelnetEventTypeT Source #

eventSubnegotiation :: TelnetEventTypeT Source #

eventCompress :: TelnetEventTypeT Source #

eventZmp :: TelnetEventTypeT Source #

Data in Warning and Error events, modeled after struct error_t inside telnet_event_t.

eventTType :: TelnetEventTypeT Source #

data ErrorT Source #

Constructors

ErrorT
Fields _file :: CString _func :: CString _msg :: CString _line :: CInt _errcode :: TelnetErrorT

eventEnviron :: TelnetEventTypeT Source #

eventMssp :: TelnetEventTypeT Source #

eventWarning :: TelnetEventTypeT Source #

eventError :: TelnetEventTypeT Source #

Constants from telnet_error_t.

newtype TelnetErrorT Source #

Constructors

TelnetErrorT
Fields unTelnetErrorT :: CInt

Instances

Eq TelnetErrorT Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods (==) :: TelnetErrorT -> TelnetErrorT -> Bool # (/=) :: TelnetErrorT -> TelnetErrorT -> Bool #
Show TelnetErrorT Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods showsPrec :: Int -> TelnetErrorT -> ShowS # show :: TelnetErrorT -> String # showList :: [TelnetErrorT] -> ShowS #
Storable TelnetErrorT Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods sizeOf :: TelnetErrorT -> Int # alignment :: TelnetErrorT -> Int # peekElemOff :: Ptr TelnetErrorT -> Int -> IO TelnetErrorT # pokeElemOff :: Ptr TelnetErrorT -> Int -> TelnetErrorT -> IO () # peekByteOff :: Ptr b -> Int -> IO TelnetErrorT # pokeByteOff :: Ptr b -> Int -> TelnetErrorT -> IO () # peek :: Ptr TelnetErrorT -> IO TelnetErrorT # poke :: Ptr TelnetErrorT -> TelnetErrorT -> IO () #

errOK :: TelnetErrorT Source #

errBadVal :: TelnetErrorT Source #

errNoMem :: TelnetErrorT Source #

errOverflow :: TelnetErrorT Source #

errProtocol :: TelnetErrorT Source #

errCompress :: TelnetErrorT Source #

Constants for TERMINAL-TYPE commands.

newtype TCmd Source #

Constructors

TCmd
Fields unTCmd :: CUChar

Instances

Eq TCmd Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods (==) :: TCmd -> TCmd -> Bool # (/=) :: TCmd -> TCmd -> Bool #
Show TCmd Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods showsPrec :: Int -> TCmd -> ShowS # show :: TCmd -> String # showList :: [TCmd] -> ShowS #
Storable TCmd Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods sizeOf :: TCmd -> Int # alignment :: TCmd -> Int # peekElemOff :: Ptr TCmd -> Int -> IO TCmd # pokeElemOff :: Ptr TCmd -> Int -> TCmd -> IO () # peekByteOff :: Ptr b -> Int -> IO TCmd # pokeByteOff :: Ptr b -> Int -> TCmd -> IO () # peek :: Ptr TCmd -> IO TCmd # poke :: Ptr TCmd -> TCmd -> IO () #

tCmdIs :: TCmd Source #

tCmdSend :: TCmd Source #

newtype ECmd Source #

Constants for ENVIRON/NEW-ENVIRON commands.

Constructors

ECmd
Fields unECmd :: CUChar

Instances

Eq ECmd Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods (==) :: ECmd -> ECmd -> Bool # (/=) :: ECmd -> ECmd -> Bool #
Show ECmd Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods showsPrec :: Int -> ECmd -> ShowS # show :: ECmd -> String # showList :: [ECmd] -> ShowS #
Storable ECmd Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods sizeOf :: ECmd -> Int # alignment :: ECmd -> Int # peekElemOff :: Ptr ECmd -> Int -> IO ECmd # pokeElemOff :: Ptr ECmd -> Int -> ECmd -> IO () # peekByteOff :: Ptr b -> Int -> IO ECmd # pokeByteOff :: Ptr b -> Int -> ECmd -> IO () # peek :: Ptr ECmd -> IO ECmd # poke :: Ptr ECmd -> ECmd -> IO () #

eCmdIs :: ECmd Source #

eCmdSend :: ECmd Source #

eCmdInfo :: ECmd Source #

newtype EVar Source #

Constants for ENVIRON/NEW-ENVIRON variables.

Constructors

EVar
Fields unEvar :: CUChar

Instances

Eq EVar Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods (==) :: EVar -> EVar -> Bool # (/=) :: EVar -> EVar -> Bool #
Show EVar Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods showsPrec :: Int -> EVar -> ShowS # show :: EVar -> String # showList :: [EVar] -> ShowS #
Storable EVar Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods sizeOf :: EVar -> Int # alignment :: EVar -> Int # peekElemOff :: Ptr EVar -> Int -> IO EVar # pokeElemOff :: Ptr EVar -> Int -> EVar -> IO () # peekByteOff :: Ptr b -> Int -> IO EVar # pokeByteOff :: Ptr b -> Int -> EVar -> IO () # peek :: Ptr EVar -> IO EVar # poke :: Ptr EVar -> EVar -> IO () #

eVar :: EVar Source #

eValue :: EVar Source #

eUserVar :: EVar Source #

newtype MsspVar Source #

Constants for MSSP.

Constructors

MsspVar
Fields unMsspVar :: CUChar

Instances

Eq MsspVar Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods (==) :: MsspVar -> MsspVar -> Bool # (/=) :: MsspVar -> MsspVar -> Bool #
Show MsspVar Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods showsPrec :: Int -> MsspVar -> ShowS # show :: MsspVar -> String # showList :: [MsspVar] -> ShowS #
Storable MsspVar Source #
Instance details Defined in Network.Telnet.LibTelnet.Types Methods sizeOf :: MsspVar -> Int # alignment :: MsspVar -> Int # peekElemOff :: Ptr MsspVar -> Int -> IO MsspVar # pokeElemOff :: Ptr MsspVar -> Int -> MsspVar -> IO () # peekByteOff :: Ptr b -> Int -> IO MsspVar # pokeByteOff :: Ptr b -> Int -> MsspVar -> IO () # peek :: Ptr MsspVar -> IO MsspVar # poke :: Ptr MsspVar -> MsspVar -> IO () #

msspVar :: MsspVar Source #

msspVal :: MsspVar Source #

data TelnetEnvironT Source #

ENVIRONMENT/NEW-ENVIRONMENT/MSSP messages, wrapping telnet_environ_t.

Constructors

TelnetEnvironT
Fields _type :: EVar unsigned char type _var :: CString char var _value :: CString char value

Instances

Storable TelnetEnvironT Source #

Instance details

Defined in Network.Telnet.LibTelnet.Types

Methods

sizeOf :: TelnetEnvironT -> Int #

alignment :: TelnetEnvironT -> Int #

peekElemOff :: Ptr TelnetEnvironT -> Int -> IO TelnetEnvironT #

pokeElemOff :: Ptr TelnetEnvironT -> Int -> TelnetEnvironT -> IO () #

peekByteOff :: Ptr b -> Int -> IO TelnetEnvironT #

pokeByteOff :: Ptr b -> Int -> TelnetEnvironT -> IO () #

peek :: Ptr TelnetEnvironT -> IO TelnetEnvironT #

poke :: Ptr TelnetEnvironT -> TelnetEnvironT -> IO () #