Safe Haskell	None
Language	Haskell2010

Network.Mattermost.Types.Base

Description

These are the fundamental types that are used for building everything else. Specifically, these types are used by the Network.Mattermost.Types.Internal, but are not subject to the cautions that as associated with the latter.

Synopsis

type Hostname = Text
type Port = Int
type Logger = LogEvent -> IO ()
data LogEvent = LogEvent {
- logFunction :: String
- logEventType :: LogEventType
}
data LogEventType
- = HttpRequest RequestMethod String (Maybe Value)
- | HttpResponse Int String (Maybe Value)
- | WebSocketRequest Value
- | WebSocketResponse (Either String Value)
- | WebSocketPing
- | WebSocketPong
newtype ServerTime = ServerTime {
- withServerTime :: UTCTime
}

Documentation

type Hostname = Text Source #

type Port = Int Source #

type Logger = LogEvent -> IO () Source #

A Logger is any function which responds to log events:

data LogEvent Source #

If there is a Logger in the ConnectionData struct, it will be sporadically called with values of type LogEvent.

Constructors

LogEvent
Fields logFunction :: String logEventType :: LogEventType

Instances

Eq LogEvent Source #
Instance details Defined in Network.Mattermost.Types.Base Methods (==) :: LogEvent -> LogEvent -> Bool # (/=) :: LogEvent -> LogEvent -> Bool #
Show LogEvent Source #
Instance details Defined in Network.Mattermost.Types.Base Methods showsPrec :: Int -> LogEvent -> ShowS # show :: LogEvent -> String # showList :: [LogEvent] -> ShowS #

data LogEventType Source #

A LogEventType describes the particular event that happened

Constructors

HttpRequest RequestMethod String (Maybe Value)
HttpResponse Int String (Maybe Value)
WebSocketRequest Value
WebSocketResponse (Either String Value)	Left means we got an exception trying to parse the response; Right means we succeeded and here it is.
WebSocketPing
WebSocketPong

Instances

Eq LogEventType Source #
Instance details Defined in Network.Mattermost.Types.Base Methods (==) :: LogEventType -> LogEventType -> Bool # (/=) :: LogEventType -> LogEventType -> Bool #
Show LogEventType Source #
Instance details Defined in Network.Mattermost.Types.Base Methods showsPrec :: Int -> LogEventType -> ShowS # show :: LogEventType -> String # showList :: [LogEventType] -> ShowS #

newtype ServerTime Source #

The time as provided by the Server. This is a wrapper designed to warn against naive comparisons to local times: the server's time and local times are not necessarily synchronized.

Constructors

ServerTime
Fields withServerTime :: UTCTime

Instances

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