Neptune.Session

Documentation

data ClientToken

Decoded client token

Constructors

ClientToken

Fields

• _ct_token :: Text

  user secret

• _ct_api_address :: Text

  neptune api address

• _ct_api_url :: Text

  neptune api address

• _ct_api_key :: Text

  neptune api key (not used)

Instances

Show ClientToken

Defined in Neptune.Session

Methods

showsPrec :: Int -> ClientToken -> ShowS

show :: ClientToken -> String

showList :: [ClientToken] -> ShowS

Generic ClientToken

Defined in Neptune.Session

Associated Types

type Rep ClientToken :: Type -> Type

Methods

from :: ClientToken -> Rep ClientToken x

to :: Rep ClientToken x -> ClientToken

FromEnv ClientToken

Defined in Neptune.Session

Methods

fromEnv :: Maybe ClientToken -> Parser ClientToken

type Rep ClientToken

Defined in Neptune.Session

type Rep ClientToken = D1 ('MetaData "ClientToken" "Neptune.Session" "neptune-backend-0.3.0-B6AQsu3QknaBGHUpo43rDz" 'False) (C1 ('MetaCons "ClientToken" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_ct_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_ct_api_address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "_ct_api_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_ct_api_key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

type Dispatcher = forall req contentType res accept. (Produces req accept, MimeUnrender accept res, MimeType contentType, HasCallStack) => NeptuneBackendRequest req contentType res accept -> IO res

data NeptuneSession

Neptune session. It contains all necessary information to communicate the server.

Constructors

NeptuneSession

Fields

• _neptune_http_manager :: Manager
• _neptune_client_token :: ClientToken
• _neptune_config :: NeptuneBackendConfig
• _neptune_oauth2 :: MVar OAuth2Session
• _neptune_oauth2_refresh :: ThreadId

  Background thread for updating OAuth2 token

• _neptune_project :: ProjectWithRoleDTO

  Active project

• _neptune_dispatch :: Dispatcher

  Dispatching function for http requests

data Experiment

Constructors

Experiment

Fields

• _exp_experiment_id :: ExperimentId

  Experiment Id

• _exp_outbound_q :: TChan DataPointAny

  Output queue

• _exp_user_channels :: ChannelHashMap

  Active output channels

• _exp_stop_flag :: Event

  Event flag to indicate the end of the session

• _exp_transmitter_flag :: Event

  Event flag to indicate completion of transmission

• _exp_transmitter :: ThreadId

  Background thread for transmission

• _exp_abort_handler :: ThreadId

class (Typeable a, Show a) => NeptDataType a where

Methods

neptChannelType :: Proxy a -> ChannelTypeEnum

toNeptPoint :: DataPoint a -> Point

Instances

NeptDataType Double

Defined in Neptune.Session

Methods

neptChannelType :: Proxy Double -> ChannelTypeEnum

toNeptPoint :: DataPoint Double -> Point

newtype DataChannel a

Type-safe data channel

Constructors

DataChannel Text

Channel Id

Instances

Show (DataChannel a)

Defined in Neptune.Session

Methods

showsPrec :: Int -> DataChannel a -> ShowS

show :: DataChannel a -> String

showList :: [DataChannel a] -> ShowS

data DataChannelAny

Data channel of any type

Constructors

forall a.NeptDataType a => DataChannelAny (DataChannel a)

Instances

Show DataChannelAny

Defined in Neptune.Session

Methods

showsPrec :: Int -> DataChannelAny -> ShowS

show :: DataChannelAny -> String

showList :: [DataChannelAny] -> ShowS

type ChannelHashMap = TVar (HashMap Text DataChannelAny)

Hashmap of all channels in use

data DataPoint a

Type-safe data point

Constructors

DataPoint

Fields

• _dpt_name :: Text
• _dpt_timestamp :: UTCTime
• _dpt_value :: a

Instances

Show a => Show (DataPoint a)

Defined in Neptune.Session

Methods

showsPrec :: Int -> DataPoint a -> ShowS

show :: DataPoint a -> String

showList :: [DataPoint a] -> ShowS

data DataPointAny

Data point of any type

Constructors

forall a.NeptDataType a => DataPointAny (DataPoint a)

Instances

Show DataPointAny

Defined in Neptune.Session

Methods

showsPrec :: Int -> DataPointAny -> ShowS

show :: DataPointAny -> String

showList :: [DataPointAny] -> ShowS

ct_token :: Lens' ClientToken Text

ct_api_url :: Lens' ClientToken Text

ct_api_key :: Lens' ClientToken Text

ct_api_address :: Lens' ClientToken Text

neptune_project :: Lens' NeptuneSession ProjectWithRoleDTO

neptune_oauth2_refresh :: Lens' NeptuneSession ThreadId

neptune_oauth2 :: Lens' NeptuneSession (MVar OAuth2Session)

neptune_http_manager :: Lens' NeptuneSession Manager

neptune_config :: Lens' NeptuneSession NeptuneBackendConfig

neptune_client_token :: Lens' NeptuneSession ClientToken

exp_user_channels :: Lens' Experiment ChannelHashMap

exp_transmitter_flag :: Lens' Experiment Event

exp_transmitter :: Lens' Experiment ThreadId

exp_stop_flag :: Lens' Experiment Event

exp_outbound_q :: Lens' Experiment (TChan DataPointAny)

exp_experiment_id :: Lens' Experiment ExperimentId

exp_abort_handler :: Lens' Experiment ThreadId

dpt_value :: forall a a. Lens (DataPoint a) (DataPoint a) a a

dpt_timestamp :: forall a. Lens' (DataPoint a) UTCTime

dpt_name :: forall a. Lens' (DataPoint a) Text

dpt_name_A :: Lens' DataPointAny Text

Lens to get/set _dpt_name for DataPointAny

dpt_timestamp_A :: Lens' DataPointAny UTCTime

Lens to get/set _dpt_timestamp for DataPointAny