AJA NTV2 SDK  17.6.0.2675
NTV2 SDK 17.6.0.2675
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 // Local URL schemes:
42 #define kLegalSchemeNTV2 "ntv2"
43 #define kLegalSchemeNTV2Local "ntv2local"
44 
45 // Exported Function Names:
46 #define kFuncNameCreateClient "CreateClient"
47 #define kFuncNameCreateServer "CreateServer"
48 #define kFuncNameGetRegInfo "GetRegistrationInfo"
49 
50 // Other Info Keys:
51 #define kNTV2PluginInfoKey_PluginsPath "PluginsPath"
52 #define kNTV2PluginInfoKey_PluginPath "PluginPath"
53 #define kNTV2PluginInfoKey_PluginSigPath "PluginSigPath"
54 #define kNTV2PluginInfoKey_PluginBaseName "PluginBaseName"
55 #define kNTV2PluginInfoKey_Fingerprint "serial number"
56 #define kNTV2PluginInfoKey_Errors "errors"
57 
58 // Plugin Registration Info Keys:
59 #define kNTV2PluginRegInfoKey_Vendor "Vendor"
60 #define kNTV2PluginRegInfoKey_CommonName "CommonName"
61 #define kNTV2PluginRegInfoKey_OrgUnit "OrgUnit"
62 #define kNTV2PluginRegInfoKey_ShortName "ShortName"
63 #define kNTV2PluginRegInfoKey_LongName "LongName"
64 #define kNTV2PluginRegInfoKey_Description "Description"
65 #define kNTV2PluginRegInfoKey_Copyright "Copyright"
66 #define kNTV2PluginRegInfoKey_NTV2SDKVersion "NTV2SDKVersion"
67 #define kNTV2PluginRegInfoKey_Version "Version"
68 #define kNTV2PluginRegInfoKey_CommitSHA "CommitSHA"
69 #define kNTV2PluginRegInfoKey_ReqParams "RequiredParams"
70 #define kNTV2PluginRegInfoKey_OptParams "OptionalParams"
71 
72 // Plugin Signature File Keys:
73 #define kNTV2PluginSigFileKey_X509Certificate "X509Certificate"
74 #define kNTV2PluginSigFileKey_Signature "Signature"
75 
76 // X509 Certificate Attribute Keys:
77 #define kNTV2PluginX500AttrKey_CommonName "CN"
78 #define kNTV2PluginX500AttrKey_LocalityName "L"
79 #define kNTV2PluginX500AttrKey_StateOrProvinceName "ST"
80 #define kNTV2PluginX500AttrKey_OrganizationName "O"
81 #define kNTV2PluginX500AttrKey_OrganizationalUnitName "OU"
82 #define kNTV2PluginX500AttrKey_CountryName "C"
83 
84 extern uint32_t gBaseConstructCount; // Number of NTV2RPCBase constructor calls made
85 extern uint32_t gBaseDestructCount; // Number of NTV2RPCBase destructor calls made
86 extern uint32_t gClientConstructCount; // Number of NTV2RPCClient constructor calls made
87 extern uint32_t gClientDestructCount; // Number of NTV2RPCClient destructor calls made
88 extern uint32_t gServerConstructCount; // Number of NTV2RPCServer constructor calls made
89 extern uint32_t gServerDestructCount; // Number of NTV2RPCServer destructor calls made
90 extern uint32_t gLoaderConstructCount; // Number of NTV2PluginLoader constructor calls made
91 extern uint32_t gLoaderDestructCount; // Number of NTV2PluginLoader destructor calls made
92 extern uint32_t gPluginConstructCount; // Number of NTV2Plugin constructor calls made
93 extern uint32_t gPluginDestructCount; // Number of NTV2Plugin destructor calls made
94 
98 class AJAExport NTV2Dictionary
99 {
100  public:
104  inline size_t size (void) const {return mDict.size();}
106  inline bool empty (void) const {return mDict.empty();}
107  inline bool hasKey (const std::string & inKey) const {return mDict.find(inKey) != mDict.end();}
108  std::string valueForKey (const std::string & inKey) const;
109  uint16_t u16ValueForKey (const std::string & inKey, const uint16_t inDefault = 0) const;
110  NTV2StringSet keys (void) const;
111  size_t largestKeySize (void) const;
112  size_t largestValueSize (void) const;
113  std::ostream & Print (std::ostream & oss, const bool inCompact = true) const;
114  bool serialize (std::string & outStr) const;
115 
120  inline void clear (void) {mDict.clear();}
122  bool insert (const std::string & inKey, const std::string & inValue);
123  inline size_t erase (const std::string & inKey) {return hasKey(inKey) ? mDict.erase(inKey) : 0;}
124  size_t updateFrom (const NTV2Dictionary & inDict);
125  size_t addFrom (const NTV2Dictionary & inDict);
126  bool deserialize (const std::string & inStr);
127  #if !defined(NTV2_DEPRECATE_17_1)
128  inline NTV2_DEPRECATED_f(size_t UpdateFrom (const NTV2Dictionary & inDict)) {return updateFrom(inDict);}
129  inline NTV2_DEPRECATED_f(size_t AddFrom (const NTV2Dictionary & inDict)) {return addFrom(inDict);}
130  #endif // !defined(NTV2_DEPRECATE_17_1)
131 
133  public:
134  typedef std::map<std::string, std::string> Dict;
135  typedef Dict::const_iterator DictConstIter;
136  inline size_t initializeFrom (const Dict & inDict) {mDict = inDict; return size();}
137 
138  private:
139  Dict mDict;
140 }; // NTV2Dictionary
141 
142 typedef NTV2Dictionary NTV2Dict;
143 typedef NTV2Dictionary NTV2ConnectParams;
144 typedef NTV2Dictionary NTV2ConfigParams;
145 typedef std::pair<std::string, std::string> NTV2DictionaryEntry, NTV2DictEntry, NTV2ConnectParam;
146 
147 inline std::ostream & operator << (std::ostream & oss, const NTV2Dictionary & inDict) {return inDict.Print(oss);}
148 
155 class AJAExport NTV2DeviceSpecParser
156 {
157  public:
158  NTV2DeviceSpecParser (const std::string inSpec = "");
159  void Reset (const std::string inSpec = "");
160  inline const std::string & DeviceSpec (void) const {return mSpec;}
161  inline bool HasDeviceSpec (void) const {return !DeviceSpec().empty();}
162  inline bool Successful (void) const {return !Failed();}
163  inline bool Failed (void) const {return DeviceSpec().empty() ? true : HasErrors();}
164  inline bool HasScheme (void) const {return HasResult(kConnectParamScheme);}
165  inline std::string Scheme (void) const {return Result(kConnectParamScheme);}
166  inline bool IsLocalDevice (void) const {return Scheme() == kLegalSchemeNTV2Local || Scheme() == kLegalSchemeNTV2;}
167  inline size_t ErrorCount (void) const {return mErrors.size();}
168  inline bool HasErrors (void) const {return ErrorCount() > 0;}
169  inline std::string Error (const size_t inIndex = 0) const {if (inIndex < mErrors.size()) return mErrors.at(inIndex); return "";}
170  inline NTV2StringList Errors (void) const {return mErrors;}
171  inline NTV2ConnectParams Results (void) const {return mResult;}
172  inline bool HasResult (const std::string & inKey) const {return mResult.hasKey(inKey);}
173  std::string Result (const std::string & inKey) const {return mResult.valueForKey(inKey);}
174  std::string Resource (const bool inStripLeadSlash = true) const;
175  std::ostream & PrintErrors (std::ostream & oss) const;
176  std::ostream & Print (std::ostream & oss, const bool inDumpResults = false) const;
177  std::string InfoString (void) const;
178  std::string DeviceSerial (void) const {return Result(kConnectParamDevSerial);}
179  inline std::string DeviceModel (void) const {return Result(kConnectParamDevModel);}
180  NTV2DeviceID DeviceID (void) const;
181  UWord DeviceIndex (void) const;
182  inline const NTV2Dictionary & QueryParams (void) const {return mQueryParams;}
183  inline std::string QueryParam (const std::string & inKey) const {return mQueryParams.valueForKey(inKey);}
184  #if defined(_DEBUG)
185  static void test (void);
186  #endif // defined(_DEBUG)
187 
188  private:
189  void Parse (void);
190  bool ParseHexNumber (size_t & pos, std::string & outToken);
191  bool ParseDecNumber (size_t & pos, std::string & outToken);
192  bool ParseAlphaNumeric (size_t & pos, std::string & outToken, const std::string & inOtherChars = ""); // A run of letters and/or decimal digits and/or other chars
193  bool ParseScheme (size_t & pos, std::string & outToken); // An alphanumeric name followed by "://"
194  bool ParseSerialNum (size_t & pos, std::string & outToken); // An 8 or 9 character alphanumeric name or a 64-bit hex number
195  bool ParseDeviceID (size_t & pos, std::string & outToken); // An 32-bit hex number that matches a known NTV2DeviceID
196  bool ParseModelName (size_t & pos, std::string & outToken); // An alphanumeric name that matches a known device model name
197  bool ParseDNSName (size_t & pos, std::string & outDNSName); // A domain name: one or more alphanumeric names separated with '.'
198  bool ParseIPv4Address (size_t & pos, std::string & outIPv4); // Exactly four decimal numbers, each no greater than 255, separated with '.'
199  bool ParseHostAddressAndPortNumber (size_t & pos, std::string & outAddr, std::string & outPort); // A host name or IPv4 address with an optional port number
200  bool ParseResourcePath (size_t & pos, std::string & outRsrc); // One or more '/'-separated alphanumeric names
201  bool ParseParamAssignment (size_t & pos, std::string & outKey, std::string & outValue); // An alphanumeric key optionally followed by '=' optionally followed by URL-encoded value string
202  bool ParseQuery (size_t & pos, NTV2Dictionary & outParams); // Starts with '?' one or more '&'-separated param assignments
203  inline int LargestResultKey (void) const {return int(mResult.largestKeySize());}
204  inline int LargestResultValue (void) const {return int(mResult.largestValueSize());}
205  inline char CharAt (const size_t inPos) {return inPos < mSpec.length() ? mSpec.at(inPos) : 0;}
206  inline size_t SpecLength (void) const {return mSpec.length();}
207  inline size_t CurrentPosition (void) const {return mPos;}
208  inline void AddError (const std::string & inError) {mErrors.push_back(inError);}
209  static bool IsUpperLetter (const char inChar);
210  static bool IsLowerLetter (const char inChar);
211  static bool IsLetter (const char inChar, const bool inIncludeUnderscore = false);
212  static bool IsDecimalDigit (const char inChar);
213  static bool IsHexDigit (const char inChar);
214  static bool IsLegalSerialNumChar (const char inChar);
215 
216  private:
217  std::string mSpec;
218  NTV2StringList mErrors;
219  NTV2ConnectParams mResult;
220  NTV2Dictionary mQueryParams;
221  size_t mPos;
222 }; // NTV2DeviceSpecParser
223 
224 
228 class AJAExport NTV2RPCBase
229 {
230  public:
231  static std::string ShortSDKVersion (void);
232  static std::string AJAFingerprint (const bool inLowerCase = false, const bool inStripColons = false);
233 
234  protected:
235  NTV2RPCBase (NTV2Dictionary params, uint32_t * pRefCon);
236  virtual ~NTV2RPCBase ();
237  bool SetParams (const NTV2ConfigParams & inNewParams, const bool inAugment = false);
238 
239  protected:
240  NTV2Dictionary mParams;
241  mutable AJALock mParamLock;
242  uint32_t * mpRefCon;
243 }; // NTV2RPCBase
244 
245 
258 class AJAExport NTV2RPCClientAPI : public NTV2RPCBase
259 {
260  public:
266  static NTV2RPCClientAPI * CreateClient (NTV2ConnectParams & inParams);
267 
268  public:
272  virtual std::string HostName (void) const {return ConnectParam(kConnectParamHost);}
274  virtual std::string Name (void) const {return "";}
275  virtual std::string Description (void) const;
276  virtual std::ostream & Print (std::ostream & oss) const;
278 
282  virtual bool NTV2Connect (void);
284  virtual bool NTV2Disconnect (void);
285  virtual bool IsConnected (void) const {return false;}
286 
291  virtual NTV2ConnectParams ConnectParams (void) const;
293  virtual bool HasConnectParam (const std::string & inParam) const;
294  virtual std::string ConnectParam (const std::string & inParam) const;
295  virtual bool ConnectHasScheme (void) const;
296  virtual inline bool SetConnectParams (const NTV2ConnectParams & inNewParams, const bool inAugment = false) {return !IsConnected() && SetParams(inNewParams, inAugment);}
297 
302  virtual bool NTV2ReadRegisterRemote (const ULWord regNum, ULWord & outRegValue, const ULWord regMask, const ULWord regShift);
304  virtual bool NTV2WriteRegisterRemote (const ULWord regNum, const ULWord regValue, const ULWord regMask, const ULWord regShift);
305  virtual bool NTV2AutoCirculateRemote (AUTOCIRCULATE_DATA & autoCircData);
306  virtual bool NTV2WaitForInterruptRemote (const INTERRUPT_ENUMS eInterrupt, const ULWord timeOutMs);
307  virtual bool NTV2DMATransferRemote (const NTV2DMAEngine inDMAEngine, const bool inIsRead,
308  const ULWord inFrameNumber, NTV2Buffer & inOutBuffer,
309  const ULWord inCardOffsetBytes, const ULWord inNumSegments,
310  const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch,
311  const bool inSynchronous);
312  virtual bool NTV2MessageRemote (NTV2_HEADER * pInMessage);
314 
318  virtual bool NTV2GetBoolParamRemote (const ULWord inParamID, ULWord & outValue); // New in SDK 17.0
320  virtual bool NTV2GetNumericParamRemote (const ULWord inParamID, ULWord & outValue); // New in SDK 17.0
321  virtual bool NTV2GetSupportedRemote (const ULWord inEnumsID, ULWordSet & outSupported); // New in SDK 17.0
323 
338  virtual bool NTV2QueryDevices (NTV2StringList & outDeviceInfos, std::string & outErrMsg)
339  {
340  outErrMsg.clear();
341  outDeviceInfos.clear();
342  return true;
343  }
344 
345  #if !defined(NTV2_DEPRECATE_16_3) // These functions are going away
346  virtual bool NTV2DriverGetBitFileInformationRemote (BITFILE_INFO_STRUCT & bitFileInfo, const NTV2BitFileType bitFileType);
347  virtual bool NTV2DriverGetBuildInformationRemote (BUILD_INFO_STRUCT & buildInfo);
348  virtual bool NTV2DownloadTestPatternRemote (const NTV2Channel channel, const NTV2PixelFormat testPatternFBF,
349  const UWord signalMask, const bool testPatDMAEnb, const ULWord testPatNum);
350  virtual bool NTV2ReadRegisterMultiRemote (const ULWord numRegs, ULWord & outFailedRegNum, NTV2RegInfo outRegs[]);
351  virtual bool NTV2GetDriverVersionRemote (ULWord & outDriverVersion);
352  #endif // !defined(NTV2_DEPRECATE_16_3)
353 
354  virtual ~NTV2RPCClientAPI();
355 
356  protected:
357  NTV2RPCClientAPI (NTV2ConnectParams inParams, void * pRefCon);
358 
359  virtual bool NTV2OpenRemote (void);
360  virtual bool NTV2CloseRemote (void);
361 
362  protected:
363  uint32_t mSpare[1024];
364 }; // NTV2RPCClientAPI
365 
366 typedef NTV2RPCClientAPI NTV2RPCAPI;
367 
368 inline std::ostream & operator << (std::ostream & oss, const NTV2RPCClientAPI & inObj) {return inObj.Print(oss);}
369 
374 class AJAExport NTV2RPCServerAPI : public NTV2RPCBase
375 {
376  public:
384  static NTV2RPCServerAPI * CreateServer (NTV2ConfigParams & inParams);
385 
394  static NTV2RPCServerAPI * CreateServer (const std::string & inURL);
395 
396  public:
400  virtual std::ostream & Print (std::ostream & oss) const;
402  virtual inline bool IsRunning (void) const {return mRunning;}
403 
408  virtual NTV2ConfigParams ConfigParams (void) const;
410  virtual bool HasConfigParam (const std::string & inParam) const;
411  virtual std::string ConfigParam (const std::string & inParam) const;
412  virtual inline bool SetConfigParams (const NTV2ConfigParams & inNewParams, const bool inAugment = false) {return SetParams(inNewParams, inAugment);}
413 
418  virtual void RunServer (void);
420  virtual inline void Stop (void) {mTerminate = true;}
421 
423  protected:
424  NTV2RPCServerAPI (NTV2ConnectParams inParams, void * pRefCon);
425  virtual ~NTV2RPCServerAPI();
426 
427  protected:
428  bool mRunning;
429  bool mTerminate;
430  uint32_t mSpare[1024];
431 }; // NTV2RPCServerAPI
432 
433 inline std::ostream & operator << (std::ostream & oss, const NTV2RPCServerAPI & inObj) {return inObj.Print(oss);}
434 
440 extern "C"
441 {
455  typedef bool (*fpGetRegistrationInfo) (const uint32_t /*inHostSDKVers*/, NTV2Dictionary & /*outInfo*/);
456 
464  typedef NTV2RPCClientAPI* (*fpCreateClient) (void * /*pRefCon*/, const NTV2ConnectParams & /*inParams*/, const uint32_t /*inHostSDKVersion*/);
465 
474  typedef NTV2RPCServerAPI* (*fpCreateServer) (void * /*pRefCon*/, const NTV2ConfigParams & /*inParams*/, const uint32_t /*inHostSDKVersion*/);
475 
476  #if !defined(NTV2_DEPRECATE_16_3) // Don't use these functions going forward
477  typedef NTV2RPCAPI* (*fpCreateNTV2SoftwareDevice) (void * /*pInDLLHandle*/, const std::string & /*inQueryStr*/, const uint32_t /*inHostSDKVersion*/);
478  #endif // !defined(NTV2_DEPRECATE_16_3)
479 }
480 
481 #endif // NTV2NUBACCESS_H
NTV2ConfigParams
NTV2Dictionary NTV2ConfigParams
A dictionary of parameters used to configure an RPC server.
Definition: ntv2nubaccess.h:144
kLegalSchemeNTV2Local
#define kLegalSchemeNTV2Local
Definition: ntv2nubaccess.h:43
INTERRUPT_ENUMS
enum _INTERRUPT_ENUMS_ INTERRUPT_ENUMS
gClientConstructCount
uint32_t gClientConstructCount
BUILD_INFO_STRUCT
Definition: ntv2publicinterface.h:5093
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:1154
NTV2Channel
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They're also commonly use...
Definition: ntv2enums.h:1346
NTV2Buffer
Describes a user-space buffer on the host computer. I have an address and a length,...
Definition: ntv2publicinterface.h:6212
NTV2Dictionary::initializeFrom
size_t initializeFrom(const Dict &inDict)
Definition: ntv2nubaccess.h:136
NTV2RPCServerAPI
Base class of objects that can serve device operation RPCs with NTV2RPCClientAPI instances.
Definition: ntv2nubaccess.h:374
NTV2RPCBase
Common base class for NTV2RPCClientAPI and NTV2RPCServerAPI.
Definition: ntv2nubaccess.h:228
NTV2DeviceIDSerialPairsConstIter
NTV2DeviceIDSerialPairs::const_iterator NTV2DeviceIDSerialPairsConstIter
Definition: ntv2nubaccess.h:21
NTV2Dict
NTV2Dictionary NTV2Dict
Definition: ntv2nubaccess.h:142
NTV2RPCBase::SetParams
bool SetParams(const NTV2ConfigParams &inNewParams, const bool inAugment=false)
Definition: ntv2nubaccess.cpp:1873
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:213
NTV2Dictionary::Print
std::ostream & Print(std::ostream &oss, const bool inCompact=true) const
Prints human-readable representation to ostream.
Definition: ntv2nubaccess.cpp:155
gClientDestructCount
uint32_t gClientDestructCount
gServerDestructCount
uint32_t gServerDestructCount
NTV2DeviceSpecParser::DeviceModel
std::string DeviceModel(void) const
Definition: ntv2nubaccess.h:179
NTV2RPCAPI
NTV2RPCClientAPI NTV2RPCAPI
Definition: ntv2nubaccess.h:366
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:240
NTV2DMAEngine
NTV2DMAEngine
Definition: ntv2enums.h:1845
ULWordSet
std::set< ULWord > ULWordSet
A collection of unique ULWord (uint32_t) values.
Definition: ntv2publicinterface.h:54
kLegalSchemeNTV2
#define kLegalSchemeNTV2
Definition: ntv2nubaccess.h:42
lock.h
Declares the AJALock class.
ULWord
uint32_t ULWord
Definition: ajatypes.h:256
NTV2ConnectParams
NTV2Dictionary NTV2ConnectParams
A dictionary of parameters used to connect to remote/fake devices.
Definition: ntv2nubaccess.h:143
NTV2BitFileType
NTV2BitFileType
Definition: ntv2enums.h:3330
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:2169
NTV2RPCServerAPI::mTerminate
bool mTerminate
Set true to stop server.
Definition: ntv2nubaccess.h:429
NTV2RPCServerAPI::mRunning
bool mRunning
Running?
Definition: ntv2nubaccess.h:428
NTV2RPCClientAPI::NTV2QueryDevices
virtual bool NTV2QueryDevices(NTV2StringList &outDeviceInfos, std::string &outErrMsg)
Queries the devices that are accessible on the remote host.
Definition: ntv2nubaccess.h:338
NTV2_HEADER
All new NTV2 structs start with this common header.
Definition: ntv2publicinterface.h:7192
UWord
uint16_t UWord
Definition: ajatypes.h:254
ntv2utils.h
Declares numerous NTV2 utility functions.
gServerConstructCount
uint32_t gServerConstructCount
NTV2RPCBase::mParamLock
AJALock mParamLock
Mutex to protect mParams.
Definition: ntv2nubaccess.h:241
gBaseConstructCount
uint32_t gBaseConstructCount
NTV2Dictionary::DictConstIter
Dict::const_iterator DictConstIter
Definition: ntv2nubaccess.h:135
NTV2StringList
std::vector< std::string > NTV2StringList
Definition: ntv2utils.h:1151
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:155
NTV2DictEntry
std::pair< std::string, std::string > NTV2DictEntry
Definition: ntv2nubaccess.h:145
NTV2DictionaryEntry
std::pair< std::string, std::string > NTV2DictionaryEntry
Definition: ntv2nubaccess.h:145
gPluginConstructCount
uint32_t gPluginConstructCount
NTV2_DEPRECATED_f
#define NTV2_DEPRECATED_f(__f__)
Definition: ajatypes.h:557
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:145
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:178
NTV2RPCClientAPI::Print
virtual std::ostream & Print(std::ostream &oss) const
Definition: ntv2nubaccess.cpp:1961
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:455
NTV2RPCClientAPI
An object that can connect to, and operate remote or fake devices. I have three general API groups:
Definition: ntv2nubaccess.h:258
NTV2Dictionary::valueForKey
std::string valueForKey(const std::string &inKey) const
Definition: ntv2nubaccess.cpp:111
NTV2RPCBase::mpRefCon
uint32_t * mpRefCon
Reserved for internal use.
Definition: ntv2nubaccess.h:242
NTV2Dictionary
A simple (not thread-safe) set of key/value pairs. (New in SDK 16.3)
Definition: ntv2nubaccess.h:98
NTV2Dictionary::Dict
std::map< std::string, std::string > Dict
Definition: ntv2nubaccess.h:134
BITFILE_INFO_STRUCT
Definition: ntv2publicinterface.h:4978
gLoaderDestructCount
uint32_t gLoaderDestructCount
AUTOCIRCULATE_DATA
Definition: ntv2publicinterface.h:4543
operator<<
std::ostream & operator<<(std::ostream &oss, const NTV2Dictionary &inDict)
Definition: ntv2nubaccess.h:147