Safe Haskell	None
Language	Haskell2010

DMCC.Agent

Description

Agents in a DMCC API session enable call control over devices.

Synopsis

data Action
- = MakeCall {
  - number :: Extension
  }
- | AnswerCall {
  - callId :: CallId
  }
- | EndCall {
  - callId :: CallId
  }
- | HoldCall {
  - callId :: CallId
  }
- | RetrieveCall {
  - callId :: CallId
  }
- | BargeIn {
  - callId :: CallId
  - pType :: ParticipationType
  }
- | ConferenceCall {
  - activeCall :: CallId
  - heldCall :: CallId
  }
- | TransferCall {
  - activeCall :: CallId
  - heldCall :: CallId
  }
- | SendDigits {
  - callId :: CallId
  - digits :: Text
  }
- | SetState {
  - newState :: SettableAgentState
  }
data AgentSnapshot = AgentSnapshot {
- _calls :: Map CallId Call
- _state :: (Maybe AgentState, Text)
}
state :: Lens' AgentSnapshot (Maybe AgentState, Text)
calls :: Lens' AgentSnapshot (Map CallId Call)
data AgentEvent
- = TelephonyEvent {
  - dmccEvent :: Event
  - newSnapshot :: AgentSnapshot
  }
- | StateChange {
  - newSnapshot :: AgentSnapshot
  }
- | TelephonyEventError {
  - errorText :: String
  }
- | RequestError {
  - errorText :: String
  }
data WHEvent = WHEvent {
- agentId :: AgentId
- event :: AgentEvent
}
data Agent = Agent {
- deviceId :: DeviceId
- monitorId :: Text
- actionChan :: TChan Action
- actionThread :: ThreadId
- rspChan :: TChan Response
- rspThread :: ThreadId
- stateThread :: ThreadId
- eventChan :: TChan AgentEvent
- snapshot :: TVar AgentSnapshot
}
newtype AgentHandle = AgentHandle (AgentId, Session)
data AgentError
- = DeviceError String
- | MonitoringError String
- | StatePollingError String
- | UnknownAgent AgentId
agentAction :: (MonadLoggerIO m, MonadCatch m) => Action -> AgentHandle -> m ()
placeAgentLock :: AgentHandle -> STM ()
releaseAgentLock :: MonadLoggerIO m => AgentHandle -> m ()
controlAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadMask m) => SwitchName -> Extension -> Session -> m (Either AgentError AgentHandle)
processAgentAction :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => AgentId -> DeviceId -> TVar AgentSnapshot -> Session -> Action -> m ()
processAgentEvent :: (MonadUnliftIO m, MonadBaseControl IO m, MonadLoggerIO m, MonadCatch m) => AgentId -> DeviceId -> TVar AgentSnapshot -> TChan AgentEvent -> Session -> Response -> m ()
sendWH :: (MonadUnliftIO m, MonadLoggerIO m, MonadCatch m) => (Request, Manager) -> AgentId -> AgentEvent -> m ()
releaseAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => AgentHandle -> m ()
handleEvents :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> (AgentEvent -> m ()) -> m ThreadId
getAgentSnapshot :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> m AgentSnapshot

Documentation

data Action Source #

Actions performable by a controlled agent.

Constructors

MakeCall
Fields number :: Extension
AnswerCall
Fields callId :: CallId
EndCall
Fields callId :: CallId
HoldCall
Fields callId :: CallId
RetrieveCall
Fields callId :: CallId
BargeIn
Fields callId :: CallId pType :: ParticipationType
ConferenceCall
Fields activeCall :: CallId heldCall :: CallId
TransferCall
Fields activeCall :: CallId heldCall :: CallId
SendDigits
Fields callId :: CallId digits :: Text
SetState
Fields newState :: SettableAgentState

Instances

Show Action Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
ToJSON Action Source #
Instance details Defined in DMCC.Agent Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding #
FromJSON Action Source #
Instance details Defined in DMCC.Agent Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #

data AgentSnapshot Source #

Constructors

AgentSnapshot
Fields _calls :: Map CallId Call _state :: (Maybe AgentState, Text) Last recognized agent state along with reason code.

Instances

Show AgentSnapshot Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> AgentSnapshot -> ShowS # show :: AgentSnapshot -> String # showList :: [AgentSnapshot] -> ShowS #
ToJSON AgentSnapshot Source #
Instance details Defined in DMCC.Agent Methods toJSON :: AgentSnapshot -> Value # toEncoding :: AgentSnapshot -> Encoding # toJSONList :: [AgentSnapshot] -> Value # toEncodingList :: [AgentSnapshot] -> Encoding #
FromJSON AgentSnapshot Source #
Instance details Defined in DMCC.Agent Methods parseJSON :: Value -> Parser AgentSnapshot # parseJSONList :: Value -> Parser [AgentSnapshot] #

state :: Lens' AgentSnapshot (Maybe AgentState, Text) Source #

calls :: Lens' AgentSnapshot (Map CallId Call) Source #

data AgentEvent Source #

Events/errors are published to external clients of the agents and may be used by agent subscribers to provide information to user.

Constructors

TelephonyEvent	A telephony-related event, along with an updated snapshot.
Fields dmccEvent :: Event newSnapshot :: AgentSnapshot
StateChange	Arrives when an agent state change has been observed.
Fields newSnapshot :: AgentSnapshot
TelephonyEventError	An error caused by a telephony-related event.
Fields errorText :: String
RequestError	An error caused by a request from this agent.
Fields errorText :: String

Instances

Show AgentEvent Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> AgentEvent -> ShowS # show :: AgentEvent -> String # showList :: [AgentEvent] -> ShowS #
ToJSON AgentEvent Source #
Instance details Defined in DMCC.Agent Methods toJSON :: AgentEvent -> Value # toEncoding :: AgentEvent -> Encoding # toJSONList :: [AgentEvent] -> Value # toEncodingList :: [AgentEvent] -> Encoding #
FromJSON AgentEvent Source #
Instance details Defined in DMCC.Agent Methods parseJSON :: Value -> Parser AgentEvent # parseJSONList :: Value -> Parser [AgentEvent] #

data WHEvent Source #

Web hook event.

Constructors

WHEvent
Fields agentId :: AgentId event :: AgentEvent

Instances

Show WHEvent Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> WHEvent -> ShowS # show :: WHEvent -> String # showList :: [WHEvent] -> ShowS #
ToJSON WHEvent Source #
Instance details Defined in DMCC.Agent Methods toJSON :: WHEvent -> Value # toEncoding :: WHEvent -> Encoding # toJSONList :: [WHEvent] -> Value # toEncodingList :: [WHEvent] -> Encoding #
FromJSON WHEvent Source #
Instance details Defined in DMCC.Agent Methods parseJSON :: Value -> Parser WHEvent # parseJSONList :: Value -> Parser [WHEvent] #

data Agent Source #

An agent controlled by a DMCC API session.

Constructors

Agent
Fields deviceId :: DeviceId monitorId :: Text actionChan :: TChan Action Actions performed by the agent. actionThread :: ThreadId rspChan :: TChan Response Input chan for XML responses for this agent (including events). rspThread :: ThreadId Response reader. stateThread :: ThreadId Agent state poller. eventChan :: TChan AgentEvent snapshot :: TVar AgentSnapshot

Instances

Show Agent Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> Agent -> ShowS # show :: Agent -> String # showList :: [Agent] -> ShowS #

newtype AgentHandle Source #

Constructors

AgentHandle (AgentId, Session)

Instances

Eq AgentHandle Source #
Instance details Defined in DMCC.Agent Methods (==) :: AgentHandle -> AgentHandle -> Bool # (/=) :: AgentHandle -> AgentHandle -> Bool #
Ord AgentHandle Source #
Instance details Defined in DMCC.Agent Methods compare :: AgentHandle -> AgentHandle -> Ordering # (<) :: AgentHandle -> AgentHandle -> Bool # (<=) :: AgentHandle -> AgentHandle -> Bool # (>) :: AgentHandle -> AgentHandle -> Bool # (>=) :: AgentHandle -> AgentHandle -> Bool # max :: AgentHandle -> AgentHandle -> AgentHandle # min :: AgentHandle -> AgentHandle -> AgentHandle #
Show AgentHandle Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> AgentHandle -> ShowS # show :: AgentHandle -> String # showList :: [AgentHandle] -> ShowS #

data AgentError Source #

Exceptions thrown by agent-related routines and threads.

Constructors

DeviceError String
MonitoringError String
StatePollingError String
UnknownAgent AgentId

Instances

Data AgentError Source #
Instance details Defined in DMCC.Agent Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AgentError -> c AgentError # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AgentError # toConstr :: AgentError -> Constr # dataTypeOf :: AgentError -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AgentError) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AgentError) # gmapT :: (forall b. Data b => b -> b) -> AgentError -> AgentError # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AgentError -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AgentError -> r # gmapQ :: (forall d. Data d => d -> u) -> AgentError -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AgentError -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AgentError -> m AgentError # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentError -> m AgentError # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AgentError -> m AgentError #
Show AgentError Source #
Instance details Defined in DMCC.Agent Methods showsPrec :: Int -> AgentError -> ShowS # show :: AgentError -> String # showList :: [AgentError] -> ShowS #
Exception AgentError Source #
Instance details Defined in DMCC.Agent Methods toException :: AgentError -> SomeException # fromException :: SomeException -> Maybe AgentError # displayException :: AgentError -> String #

agentAction :: (MonadLoggerIO m, MonadCatch m) => Action -> AgentHandle -> m () Source #

Command an agent to do something.

Due to lack of global locking of the agents map an agent may be gone (released) by the time an action arrives to its actionChan. This is by design to avoid congestion during action processing.

placeAgentLock :: AgentHandle -> STM () Source #

releaseAgentLock :: MonadLoggerIO m => AgentHandle -> m () Source #

controlAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadMask m) => SwitchName -> Extension -> Session -> m (Either AgentError AgentHandle) Source #

Enable an active agent to be monitored and controlled through DMCC API. If the agent has already been registered, return the old entry (it's safe to call this function with the same arguments multiple times).

processAgentAction :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => AgentId -> DeviceId -> TVar AgentSnapshot -> Session -> Action -> m () Source #

Translate agent actions into actual DMCC API requests.

TODO Allow agents to control only own calls.

processAgentEvent :: (MonadUnliftIO m, MonadBaseControl IO m, MonadLoggerIO m, MonadCatch m) => AgentId -> DeviceId -> TVar AgentSnapshot -> TChan AgentEvent -> Session -> Response -> m () Source #

Process DMCC API events/errors for this agent to change its snapshot and broadcast events further.

sendWH :: (MonadUnliftIO m, MonadLoggerIO m, MonadCatch m) => (Request, Manager) -> AgentId -> AgentEvent -> m () Source #

Send agent event data to a web hook endpoint, ignoring possible exceptions.

releaseAgent :: (MonadUnliftIO m, MonadLoggerIO m, MonadBaseControl IO m, MonadCatch m) => AgentHandle -> m () Source #

Forget about an agent, releasing his device and monitors.

handleEvents :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> (AgentEvent -> m ()) -> m ThreadId Source #

Attach an event handler to an agent. Exceptions are not handled.

getAgentSnapshot :: (MonadLoggerIO m, MonadThrow m) => AgentHandle -> m AgentSnapshot Source #