conscience_core::ai::CscEntityProcessCommandOptions Struct Reference

#include <CscEntityClient.h>

Static Public Member Functions
static CscEntityProcessCommandOptions	udp (optional< unsigned int > commandTimeoutSeconds={})
static CscEntityProcessCommandOptions	tcp (optional< unsigned int > commandTimeoutSeconds={})

Public Attributes
bool	canUseUdp = false
optional< unsigned int >	commandTimeoutSeconds = 45
optional< fs::path >	downloadBytesToPath = {}
optional< function< void(float progress)> >	onDownloadProgress = {}

Member Function Documentation

tcp()

CscEntityProcessCommandOptions conscience_core::ai::CscEntityProcessCommandOptions::tcp ( optional< unsigned int >  commandTimeoutSeconds = {} )

static

return tcp default process command options

udp()

CscEntityProcessCommandOptions conscience_core::ai::CscEntityProcessCommandOptions::udp ( optional< unsigned int >  commandTimeoutSeconds = {} )

static

return udp default process command options

Member Data Documentation

canUseUdp

bool conscience_core::ai::CscEntityProcessCommandOptions::canUseUdp = false

If true, UDP may be used for command transmission; otherwise, TCP is used.

commandTimeoutSeconds

optional<unsigned int> conscience_core::ai::CscEntityProcessCommandOptions::commandTimeoutSeconds = 45

The maximum time, in seconds, allowed for the command to complete. Defaults to 45 seconds.

Warning

for now only implemented on real entity TCP requests

downloadBytesToPath

optional<fs::path> conscience_core::ai::CscEntityProcessCommandOptions::downloadBytesToPath = {}

onDownloadProgress

optional<function<void(float progress)> > conscience_core::ai::CscEntityProcessCommandOptions::onDownloadProgress = {}

Requires downloadBytesToPath to be defined. Will be called on download progress. float progress from 0 to 1

---

The documentation for this struct was generated from the following files:

• ArtificialIntelligence/CscEntityClient.h
• ArtificialIntelligence/CscEntityClient.cpp