AJA NTV2 SDK  18.0.0.2717
NTV2 SDK 18.0.0.2717
ntv2nubaccess.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: MIT */
8 #ifndef NTV2NUBACCESS_H
9 #define NTV2NUBACCESS_H
10 
11 #include "ntv2utils.h" // NTV2StringList
12 #include "ajabase/system/lock.h" // AJALock
13 #include <string>
14 #include <vector>
15 #include <map>
16 
17 // TYPEDEFs
18 typedef std::pair<NTV2DeviceID, ULWord64> NTV2DeviceIDSerialPair;
19 typedef std::vector<NTV2DeviceIDSerialPair> NTV2DeviceIDSerialPairs;
20 typedef NTV2DeviceIDSerialPairs::iterator NTV2DeviceIDSerialPairsIter;
21 typedef NTV2DeviceIDSerialPairs::const_iterator NTV2DeviceIDSerialPairsConstIter;
22 
23 // Supported NTV2ConnectParams:
24 #define kConnectParamScheme "scheme"
25 #define kConnectParamHost "host"
26 #define kConnectParamPort "port"
27 #define kConnectParamDevIndex "deviceindex"
28 #define kConnectParamDevSerial "deviceserial"
29 #define kConnectParamDevModel "devicemodel"
30 #define kConnectParamDevID "deviceid"
31 #define kConnectParamResource "resourcePath"
32 #define kConnectParamQuery "query"
33 
34 // AJA query params:
35 #define kQParamVerboseLogging "verbose"
36 #define kQParamLogToStdout "stdout"
37 #define kQParamShowX509Cert "showcert"
38 #define kQParamShowParams "showparams"
39 #define kQParamDebugRegistry "debugregistry"
40 
41 // AJA VDEV params:
42 #define kQParamVDevFolderPath "vdevfpath"
43 #define kQParamVDevName "vdevname"
44 #define kQParamVDevFileName "vdevfname"
45 #define kQParamVDevIndex "vdevindex"
46 
47 // Local URL schemes:
48 #define kLegalSchemeNTV2 "ntv2"
49 #define kLegalSchemeNTV2Local "ntv2local"
50 
51 // Exported Function Names:
52 #define kFuncNameCreateClient "CreateClient"
53 #define kFuncNameCreateServer "CreateServer"
54 #define kFuncNameGetRegInfo "GetRegistrationInfo"
55 
56 // Other Info Keys:
57 #define kNTV2PluginInfoKey_PluginsPath "PluginsPath"
58 #define kNTV2PluginInfoKey_PluginPath "PluginPath"
59 #define kNTV2PluginInfoKey_PluginSigPath "PluginSigPath"
60 #define kNTV2PluginInfoKey_PluginBaseName "PluginBaseName"
61 #define kNTV2PluginInfoKey_Fingerprint "serial number"
62 #define kNTV2PluginInfoKey_Errors "errors"
63 
64 // Plugin Registration Info Keys:
65 #define kNTV2PluginRegInfoKey_Vendor "Vendor"
66 #define kNTV2PluginRegInfoKey_CommonName "CommonName"
67 #define kNTV2PluginRegInfoKey_OrgUnit "OrgUnit"
68 #define kNTV2PluginRegInfoKey_ShortName "ShortName"
69 #define kNTV2PluginRegInfoKey_LongName "LongName"
70 #define kNTV2PluginRegInfoKey_Description "Description"
71 #define kNTV2PluginRegInfoKey_Copyright "Copyright"
72 #define kNTV2PluginRegInfoKey_NTV2SDKVersion "NTV2SDKVersion"
73 #define kNTV2PluginRegInfoKey_Version "Version"
74 #define kNTV2PluginRegInfoKey_CommitSHA "CommitSHA"
75 #define kNTV2PluginRegInfoKey_ReqParams "RequiredParams"
76 #define kNTV2PluginRegInfoKey_OptParams "OptionalParams"
77 
78 // Plugin Signature File Keys:
79 #define kNTV2PluginSigFileKey_X509Certificate "X509Certificate"
80 #define kNTV2PluginSigFileKey_Signature "Signature"
81 
82 // X509 Certificate Attribute Keys:
83 #define kNTV2PluginX500AttrKey_CommonName "CN"
84 #define kNTV2PluginX500AttrKey_LocalityName "L"
85 #define kNTV2PluginX500AttrKey_StateOrProvinceName "ST"
86 #define kNTV2PluginX500AttrKey_OrganizationName "O"
87 #define kNTV2PluginX500AttrKey_OrganizationalUnitName "OU"
88 #define kNTV2PluginX500AttrKey_CountryName "C"
89 
90 extern uint32_t gBaseConstructCount; // Number of NTV2RPCBase constructor calls made
91 extern uint32_t gBaseDestructCount; // Number of NTV2RPCBase destructor calls made
92 extern uint32_t gClientConstructCount; // Number of NTV2RPCClient constructor calls made
93 extern uint32_t gClientDestructCount; // Number of NTV2RPCClient destructor calls made
94 extern uint32_t gServerConstructCount; // Number of NTV2RPCServer constructor calls made
95 extern uint32_t gServerDestructCount; // Number of NTV2RPCServer destructor calls made
96 extern uint32_t gLoaderConstructCount; // Number of NTV2PluginLoader constructor calls made
97 extern uint32_t gLoaderDestructCount; // Number of NTV2PluginLoader destructor calls made
98 extern uint32_t gPluginConstructCount; // Number of NTV2Plugin constructor calls made
99 extern uint32_t gPluginDestructCount; // Number of NTV2Plugin destructor calls made
100 
104 class AJAExport NTV2Dictionary
105 {
106  public:
110  inline size_t size (void) const {return mDict.size();}
112  inline bool empty (void) const {return mDict.empty();}
113  inline bool hasKey (const std::string & inKey) const {return mDict.find(inKey) != mDict.end();}
114  std::string valueForKey (const std::string & inKey) const;
115  uint16_t u16ValueForKey (const std::string & inKey, const uint16_t inDefault = 0) const;
116  NTV2StringSet keys (void) const;
117  size_t largestKeySize (void) const;
118  size_t largestValueSize (void) const;
119  std::ostream & Print (std::ostream & oss, const bool inCompact = true) const;
120  bool serialize (std::string & outStr) const;
121 
126  inline void clear (void) {mDict.clear();}
128  bool insert (const std::string & inKey, const std::string & inValue);
129  inline size_t erase (const std::string & inKey) {return hasKey(inKey) ? mDict.erase(inKey) : 0;}
130  size_t updateFrom (const NTV2Dictionary & inDict);
131  size_t addFrom (const NTV2Dictionary & inDict);
132  bool deserialize (const std::string & inStr);
133  #if !defined(NTV2_DEPRECATE_17_1)
134  inline NTV2_DEPRECATED_f(size_t UpdateFrom (const NTV2Dictionary & inDict)) {return updateFrom(inDict);}
135  inline NTV2_DEPRECATED_f(size_t AddFrom (const NTV2Dictionary & inDict)) {return addFrom(inDict);}
136  #endif // !defined(NTV2_DEPRECATE_17_1)
137 
139  public:
140  typedef std::map<std::string, std::string> Dict;
141  typedef Dict::const_iterator DictConstIter;
142  inline size_t initializeFrom (const Dict & inDict) {mDict = inDict; return size();}
143 
144  private:
145  Dict mDict;
146 }; // NTV2Dictionary
147 
148 typedef NTV2Dictionary NTV2Dict;
149 typedef NTV2Dictionary NTV2ConnectParams;
150 typedef NTV2Dictionary NTV2ConfigParams;
151 typedef std::pair<std::string, std::string> NTV2DictionaryEntry, NTV2DictEntry, NTV2ConnectParam;
152 
153 inline std::ostream & operator << (std::ostream & oss, const NTV2Dictionary & inDict) {return inDict.Print(oss);}
154 
161 class AJAExport NTV2DeviceSpecParser
162 {
163  public:
164  NTV2DeviceSpecParser (const std::string inSpec = "");
165  void Reset (const std::string inSpec = "");
166  inline const std::string & DeviceSpec (void) const {return mSpec;}
167  std::string MakeDeviceSpec (const bool urlEncodeQuery) const;
168  std::string MakeQueryString (const bool urlEncode) const;
169  inline bool HasDeviceSpec (void) const {return !DeviceSpec().empty();}
170  inline bool Successful (void) const {return !Failed();}
171  inline bool Failed (void) const {return DeviceSpec().empty() ? true : HasErrors();}
172  inline bool HasScheme (void) const {return HasResult(kConnectParamScheme);}
173  inline std::string Scheme (void) const {return Result(kConnectParamScheme);}
174  inline bool IsLocalDevice (void) const {return Scheme() == kLegalSchemeNTV2Local || Scheme() == kLegalSchemeNTV2;}
175  inline size_t ErrorCount (void) const {return mErrors.size();}
176  inline bool HasErrors (void) const {return ErrorCount() > 0;}
177  inline std::string Error (const size_t inIndex = 0) const {if (inIndex < mErrors.size()) return mErrors.at(inIndex); return "";}
178  inline NTV2StringList Errors (void) const {return mErrors;}
179  inline NTV2ConnectParams Results (void) const {return mResult;}
180  inline bool HasResult (const std::string & inKey) const {return mResult.hasKey(inKey);}
181  std::string Result (const std::string & inKey) const {return mResult.valueForKey(inKey);}
182  std::string Resource (const bool inStripLeadSlash = true) const;
183  std::ostream & PrintErrors (std::ostream & oss) const;
184  std::ostream & Print (std::ostream & oss, const bool inDumpResults = false) const;
185  std::string InfoString (void) const;
186  std::string DeviceSerial (void) const {return Result(kConnectParamDevSerial);}
187  inline std::string DeviceModel (void) const {return Result(kConnectParamDevModel);}
188  NTV2DeviceID DeviceID (void) const;
189  UWord DeviceIndex (void) const;
190  inline const NTV2Dictionary & QueryParams (void) const {return mQueryParams;}
191  inline std::string QueryParam (const std::string & inKey) const {return mQueryParams.valueForKey(inKey);}
192  inline bool HasQueryParams (void) const {return !QueryParams().empty();}
193  #if defined(_DEBUG)
194  static void test (void);
195  #endif // defined(_DEBUG)
196 
197  private:
198  void Parse (void);
199  bool ParseHexNumber (size_t & pos, std::string & outToken);
200  bool ParseDecNumber (size_t & pos, std::string & outToken);
201  bool ParseAlphaNum (size_t & pos, std::string & outToken, const std::string & inOtherChars = ""); // Starts with letter followed by run of letters and/or digits and/or other chars
202  bool ParseAlphaNumeric (size_t & pos, std::string & outToken, const std::string & inOtherChars = ""); // A run of letters and/or decimal digits and/or other chars
203  bool ParseScheme (size_t & pos, std::string & outToken); // An alphanumeric name followed by "://"
204  bool ParseSerialNum (size_t & pos, std::string & outToken); // An 8 or 9 character alphanumeric name or a 64-bit hex number
205  bool ParseDeviceID (size_t & pos, std::string & outToken); // An 32-bit hex number that matches a known NTV2DeviceID
206  bool ParseModelName (size_t & pos, std::string & outToken); // An alphanumeric name that matches a known device model name
207  bool ParseDNSName (size_t & pos, std::string & outDNSName); // A domain name: one or more alphanumeric names separated with '.'
208  bool ParseIPv4Address (size_t & pos, std::string & outIPv4); // Exactly four decimal numbers, each no greater than 255, separated with '.'
209  bool ParseHostAddressAndPortNumber (size_t & pos, std::string & outAddr, std::string & outPort); // A host name or IPv4 address with an optional port number
210  bool ParseResourcePath (size_t & pos, std::string & outRsrc); // One or more '/'-separated alphanumeric names
211  bool ParseParamAssignment (size_t & pos, std::string & outKey, std::string & outValue); // An alphanumeric key optionally followed by '=' optionally followed by URL-encoded value string
212  bool ParseQuery (size_t & pos, NTV2Dictionary & outParams); // Starts with '?' one or more '&'-separated param assignments
213  inline int LargestResultKey (void) const {return int(mResult.largestKeySize());}
214  inline int LargestResultValue (void) const {return int(mResult.largestValueSize());}
215  inline char CharAt (const size_t inPos) {return inPos < mSpec.length() ? mSpec.at(inPos) : 0;}
216  inline size_t SpecLength (void) const {return mSpec.length();}
217  inline size_t CurrentPosition (void) const {return mPos;}
218  inline void AddError (const std::string & inError) {mErrors.push_back(inError);}
219  static bool IsUpperLetter (const char inChar);
220  static bool IsLowerLetter (const char inChar);
221  static bool IsLetter (const char inChar, const bool inIncludeUnderscore = false);
222  static bool IsDecimalDigit (const char inChar);
223  static bool IsHexDigit (const char inChar);
224  static bool IsLegalSerialNumChar (const char inChar);
225 
226  private:
227  std::string mSpec;
228  NTV2StringList mErrors;
229  NTV2ConnectParams mResult;
230  NTV2Dictionary mQueryParams;
231  size_t mPos;
232 
233  public: // Class Methods
234  static bool ParseQueryParams (const NTV2Dictionary & inParams, NTV2Dictionary & outQueryParams);
235 }; // NTV2DeviceSpecParser
236 
237 
241 class AJAExport NTV2RPCBase
242 {
243  public:
244  static std::string ShortSDKVersion (void);
245  static std::string AJAFingerprint (const bool inLowerCase = false, const bool inStripColons = false);
246 
247  protected:
248  NTV2RPCBase (NTV2Dictionary params, uint32_t * pRefCon);
249  virtual ~NTV2RPCBase ();
250  bool SetParams (const NTV2ConfigParams & inNewParams, const bool inAugment = false);
251 
252  protected:
253  NTV2Dictionary mParams;
254  mutable AJALock mParamLock;
255  uint32_t * mpRefCon;
256 }; // NTV2RPCBase
257 
258 
271 class AJAExport NTV2RPCClientAPI : public NTV2RPCBase
272 {
273  public:
279  static NTV2RPCClientAPI * CreateClient (NTV2ConnectParams & inParams);
280 
281  public:
285  virtual std::string HostName (void) const {return ConnectParam(kConnectParamHost);}
287  virtual std::string Name (void) const {return "";}
288  virtual std::string Description (void) const;
289  virtual std::ostream & Print (std::ostream & oss) const;
291 
295  virtual bool NTV2Connect (void);
297  virtual bool NTV2Disconnect (void);
298  virtual bool IsConnected (void) const {return false;}
299 
304  virtual NTV2ConnectParams ConnectParams (void) const;
306  virtual bool HasConnectParam (const std::string & inParam) const;
307  virtual std::string ConnectParam (const std::string & inParam) const;
308  virtual bool ConnectHasScheme (void) const;
309  virtual inline bool SetConnectParams (const NTV2ConnectParams & inNewParams, const bool inAugment = false) {return !IsConnected() && SetParams(inNewParams, inAugment);}
310 
315  virtual bool NTV2ReadRegisterRemote (const ULWord regNum, ULWord & outRegValue, const ULWord regMask, const ULWord regShift);
317  virtual bool NTV2WriteRegisterRemote (const ULWord regNum, const ULWord regValue, const ULWord regMask, const ULWord regShift);
318  virtual bool NTV2AutoCirculateRemote (AUTOCIRCULATE_DATA & autoCircData);
319  virtual bool NTV2WaitForInterruptRemote (const INTERRUPT_ENUMS eInterrupt, const ULWord timeOutMs);
320  virtual bool NTV2DMATransferRemote (const NTV2DMAEngine inDMAEngine, const bool inIsRead,
321  const ULWord inFrameNumber, NTV2Buffer & inOutBuffer,
322  const ULWord inCardOffsetBytes, const ULWord inNumSegments,
323  const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch,
324  const bool inSynchronous);
325  virtual bool NTV2MessageRemote (NTV2_HEADER * pInMessage);
327 
331  virtual bool NTV2GetBoolParamRemote (const ULWord inParamID, ULWord & outValue); // New in SDK 17.0
333  virtual bool NTV2GetNumericParamRemote (const ULWord inParamID, ULWord & outValue); // New in SDK 17.0
334  virtual bool NTV2GetSupportedRemote (const ULWord inEnumsID, ULWordSet & outSupported); // New in SDK 17.0
336 
351  virtual bool NTV2QueryDevices (NTV2StringList & outDeviceInfos, std::string & outErrMsg)
352  {
353  outErrMsg.clear();
354  outDeviceInfos.clear();
355  return true;
356  }
357 
358  #if !defined(NTV2_DEPRECATE_16_3) // These functions are going away
359  virtual bool NTV2DriverGetBitFileInformationRemote (BITFILE_INFO_STRUCT & bitFileInfo, const NTV2BitFileType bitFileType);
360  virtual bool NTV2DriverGetBuildInformationRemote (BUILD_INFO_STRUCT & buildInfo);
361  virtual bool NTV2DownloadTestPatternRemote (const NTV2Channel channel, const NTV2PixelFormat testPatternFBF,
362  const UWord signalMask, const bool testPatDMAEnb, const ULWord testPatNum);
363  virtual bool NTV2ReadRegisterMultiRemote (const ULWord numRegs, ULWord & outFailedRegNum, NTV2RegInfo outRegs[]);
364  virtual bool NTV2GetDriverVersionRemote (ULWord & outDriverVersion);
365  #endif // !defined(NTV2_DEPRECATE_16_3)
366 
367  virtual ~NTV2RPCClientAPI();
368 
369  protected:
370  NTV2RPCClientAPI (NTV2ConnectParams inParams, void * pRefCon);
371 
372  virtual bool NTV2OpenRemote (void);
373  virtual bool NTV2CloseRemote (void);
374 
375  protected:
376  uint32_t mSpare[1024];
377 }; // NTV2RPCClientAPI
378 
379 typedef NTV2RPCClientAPI NTV2RPCAPI;
380 
381 inline std::ostream & operator << (std::ostream & oss, const NTV2RPCClientAPI & inObj) {return inObj.Print(oss);}
382 
387 class AJAExport NTV2RPCServerAPI : public NTV2RPCBase
388 {
389  public:
397  static NTV2RPCServerAPI * CreateServer (NTV2ConfigParams & inParams);
398 
407  static NTV2RPCServerAPI * CreateServer (const std::string & inURL);
408 
409  public:
413  virtual std::ostream & Print (std::ostream & oss) const;
415  virtual inline bool IsRunning (void) const {return mRunning;}
416 
421  virtual NTV2ConfigParams ConfigParams (void) const;
423  virtual bool HasConfigParam (const std::string & inParam) const;
424  virtual std::string ConfigParam (const std::string & inParam) const;
425  virtual inline bool SetConfigParams (const NTV2ConfigParams & inNewParams, const bool inAugment = false) {return SetParams(inNewParams, inAugment);}
426 
431  virtual void RunServer (void);
433  virtual inline void Stop (void) {mTerminate = true;}
434 
436  protected:
437  NTV2RPCServerAPI (NTV2ConnectParams inParams, void * pRefCon);
438  virtual ~NTV2RPCServerAPI();
439 
440  protected:
441  bool mRunning;
442  bool mTerminate;
443  uint32_t mSpare[1024];
444 }; // NTV2RPCServerAPI
445 
446 inline std::ostream & operator << (std::ostream & oss, const NTV2RPCServerAPI & inObj) {return inObj.Print(oss);}
447 
453 extern "C"
454 {
468  typedef bool (*fpGetRegistrationInfo) (const uint32_t /*inHostSDKVers*/, NTV2Dictionary & /*outInfo*/);
469 
477  typedef NTV2RPCClientAPI* (*fpCreateClient) (void * /*pRefCon*/, const NTV2ConnectParams & /*inParams*/, const uint32_t /*inHostSDKVersion*/);
478 
487  typedef NTV2RPCServerAPI* (*fpCreateServer) (void * /*pRefCon*/, const NTV2ConfigParams & /*inParams*/, const uint32_t /*inHostSDKVersion*/);
488 
489  #if !defined(NTV2_DEPRECATE_16_3) // Don't use these functions going forward
490  typedef NTV2RPCAPI* (*fpCreateNTV2SoftwareDevice) (void * /*pInDLLHandle*/, const std::string & /*inQueryStr*/, const uint32_t /*inHostSDKVersion*/);
491  #endif // !defined(NTV2_DEPRECATE_16_3)
492 }
493 
494 #endif // NTV2NUBACCESS_H
NTV2ConfigParams
NTV2Dictionary NTV2ConfigParams
A dictionary of parameters used to configure an RPC server.
Definition: ntv2nubaccess.h:150
kLegalSchemeNTV2Local
#define kLegalSchemeNTV2Local
Definition: ntv2nubaccess.h:49
INTERRUPT_ENUMS
enum _INTERRUPT_ENUMS_ INTERRUPT_ENUMS
gClientConstructCount
uint32_t gClientConstructCount
BUILD_INFO_STRUCT
Definition: ntv2publicinterface.h:5097
NTV2DeviceIDSerialPair
std::pair< NTV2DeviceID, ULWord64 > NTV2DeviceIDSerialPair
Identifies a device by its NTV2DeviceID and serial number.
Definition: ntv2nubaccess.h:18
NTV2StringSet
std::set< std::string > NTV2StringSet
Definition: ntv2utils.h:1158
NTV2Channel
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They're also commonly use...
Definition: ntv2enums.h:1353
NTV2Buffer
Describes a user-space buffer on the host computer. I have an address and a length,...
Definition: ntv2publicinterface.h:6216
NTV2Dictionary::initializeFrom
size_t initializeFrom(const Dict &inDict)
Definition: ntv2nubaccess.h:142
NTV2RPCServerAPI
Base class of objects that can serve device operation RPCs with NTV2RPCClientAPI instances.
Definition: ntv2nubaccess.h:387
NTV2RPCBase
Common base class for NTV2RPCClientAPI and NTV2RPCServerAPI.
Definition: ntv2nubaccess.h:241
NTV2DeviceIDSerialPairsConstIter
NTV2DeviceIDSerialPairs::const_iterator NTV2DeviceIDSerialPairsConstIter
Definition: ntv2nubaccess.h:21
NTV2Dict
NTV2Dictionary NTV2Dict
Definition: ntv2nubaccess.h:148
NTV2RPCBase::SetParams
bool SetParams(const NTV2ConfigParams &inNewParams, const bool inAugment=false)
Definition: ntv2nubaccess.cpp:1968
NTV2DeviceID
NTV2DeviceID
Identifies a specific AJA NTV2 device model number. The NTV2DeviceID is actually the PROM part number...
Definition: ntv2enums.h:20
NTV2FrameBufferFormat
NTV2FrameBufferFormat
Identifies a particular video frame buffer format. See Device Frame Buffer Formats for details.
Definition: ntv2enums.h:215
NTV2Dictionary::Print
std::ostream & Print(std::ostream &oss, const bool inCompact=true) const
Prints human-readable representation to ostream.
Definition: ntv2nubaccess.cpp:156
gClientDestructCount
uint32_t gClientDestructCount
gServerDestructCount
uint32_t gServerDestructCount
NTV2DeviceSpecParser::DeviceModel
std::string DeviceModel(void) const
Definition: ntv2nubaccess.h:187
NTV2RPCAPI
NTV2RPCClientAPI NTV2RPCAPI
Definition: ntv2nubaccess.h:379
gLoaderConstructCount
uint32_t gLoaderConstructCount
kConnectParamDevModel
#define kConnectParamDevModel
First device of this model (e.g. 'kona4')
Definition: ntv2nubaccess.h:29
NTV2RPCBase::mParams
NTV2Dictionary mParams
Copy of config params passed to my constructor.
Definition: ntv2nubaccess.h:253
NTV2DMAEngine
NTV2DMAEngine
Definition: ntv2enums.h:1852
ULWordSet
std::set< ULWord > ULWordSet
A collection of unique ULWord (uint32_t) values.
Definition: ntv2publicinterface.h:54
kLegalSchemeNTV2
#define kLegalSchemeNTV2
Definition: ntv2nubaccess.h:48
lock.h
Declares the AJALock class.
ULWord
uint32_t ULWord
Definition: ajatypes.h:276
NTV2ConnectParams
NTV2Dictionary NTV2ConnectParams
A dictionary of parameters used to connect to remote/fake devices.
Definition: ntv2nubaccess.h:149
NTV2BitFileType
NTV2BitFileType
Definition: ntv2enums.h:3337
NTV2DeviceIDSerialPairs
std::vector< NTV2DeviceIDSerialPair > NTV2DeviceIDSerialPairs
An ordered sequence of NTV2DeviceIDSerialPairs.
Definition: ntv2nubaccess.h:19
kConnectParamHost
#define kConnectParamHost
DNS name, IPv4 or sw device DLL name.
Definition: ntv2nubaccess.h:25
NTV2RPCServerAPI::Print
virtual std::ostream & Print(std::ostream &oss) const
Definition: ntv2nubaccess.cpp:2276
NTV2RPCServerAPI::mTerminate
bool mTerminate
Set true to stop server.
Definition: ntv2nubaccess.h:442
NTV2RPCServerAPI::mRunning
bool mRunning
Running?
Definition: ntv2nubaccess.h:441
NTV2RPCClientAPI::NTV2QueryDevices
virtual bool NTV2QueryDevices(NTV2StringList &outDeviceInfos, std::string &outErrMsg)
Queries the devices that are accessible on the remote host.
Definition: ntv2nubaccess.h:351
NTV2_HEADER
All new NTV2 structs start with this common header.
Definition: ntv2publicinterface.h:7196
UWord
uint16_t UWord
Definition: ajatypes.h:274
ntv2utils.h
Declares numerous NTV2 utility functions.
gServerConstructCount
uint32_t gServerConstructCount
NTV2RPCBase::mParamLock
AJALock mParamLock
Mutex to protect mParams.
Definition: ntv2nubaccess.h:254
gBaseConstructCount
uint32_t gBaseConstructCount
NTV2Dictionary::DictConstIter
Dict::const_iterator DictConstIter
Definition: ntv2nubaccess.h:141
NTV2StringList
std::vector< std::string > NTV2StringList
Definition: ntv2utils.h:1155
AJALock
Definition: lock.h:28
kConnectParamScheme
#define kConnectParamScheme
URL scheme.
Definition: ntv2nubaccess.h:24
NTV2DeviceSpecParser
One-stop shop for parsing device specifications. (New in SDK 16.3) I do very little in the way of val...
Definition: ntv2nubaccess.h:161
NTV2DictEntry
std::pair< std::string, std::string > NTV2DictEntry
Definition: ntv2nubaccess.h:151
NTV2DictionaryEntry
std::pair< std::string, std::string > NTV2DictionaryEntry
Definition: ntv2nubaccess.h:151
gPluginConstructCount
uint32_t gPluginConstructCount
NTV2_DEPRECATED_f
#define NTV2_DEPRECATED_f(__f__)
Definition: ajatypes.h:577
NTV2RegInfo
Everything needed to call CNTV2Card::ReadRegister or CNTV2Card::WriteRegister functions.
Definition: ntv2publicinterface.h:4046
NTV2ConnectParam
std::pair< std::string, std::string > NTV2ConnectParam
A parameter used to connect to remote/fake devices.
Definition: ntv2nubaccess.h:151
AJAExport
#define AJAExport
Definition: export.h:33
gPluginDestructCount
uint32_t gPluginDestructCount
true
#define true
Definition: ntv2devicefeatures.h:26
gBaseDestructCount
uint32_t gBaseDestructCount
NTV2DeviceIDSerialPairsIter
NTV2DeviceIDSerialPairs::iterator NTV2DeviceIDSerialPairsIter
Definition: ntv2nubaccess.h:20
NTV2DeviceSpecParser::DeviceSerial
std::string DeviceSerial(void) const
Definition: ntv2nubaccess.h:186
NTV2RPCClientAPI::Print
virtual std::ostream & Print(std::ostream &oss) const
Definition: ntv2nubaccess.cpp:2056
kConnectParamDevSerial
#define kConnectParamDevSerial
Device with this serial number.
Definition: ntv2nubaccess.h:28
fpGetRegistrationInfo
bool(* fpGetRegistrationInfo)(const uint32_t, NTV2Dictionary &)
Obtains a plugin's registration information. Starting in SDK 17.1, all plugins must implement this fu...
Definition: ntv2nubaccess.h:468
NTV2RPCClientAPI
An object that can connect to, and operate remote or fake devices. I have three general API groups:
Definition: ntv2nubaccess.h:271
NTV2Dictionary::valueForKey
std::string valueForKey(const std::string &inKey) const
Definition: ntv2nubaccess.cpp:112
NTV2RPCBase::mpRefCon
uint32_t * mpRefCon
Reserved for internal use.
Definition: ntv2nubaccess.h:255
NTV2Dictionary
A simple (not thread-safe) set of key/value pairs. (New in SDK 16.3)
Definition: ntv2nubaccess.h:104
NTV2Dictionary::Dict
std::map< std::string, std::string > Dict
Definition: ntv2nubaccess.h:140
BITFILE_INFO_STRUCT
Definition: ntv2publicinterface.h:4982
gLoaderDestructCount
uint32_t gLoaderDestructCount
AUTOCIRCULATE_DATA
Definition: ntv2publicinterface.h:4547
operator<<
std::ostream & operator<<(std::ostream &oss, const NTV2Dictionary &inDict)
Definition: ntv2nubaccess.h:153