C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUa::FileType Class Reference

Class implementing the UaObject interface for the FileType. More...

#include <opcua_filetype.h>

Inherits OpcUa::FileTypeBase.

Inherited by OpcUa::AddressSpaceFileType, OpcUa::TrustListTypeBase, and PubSubConfigFile.

Public Member Functions

 FileType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL, OpcUa_UInt32 clientProcessingTimeout=0)
 Construction of the class FileType. More...
 
 FileType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL, OpcUa_UInt32 clientProcessingTimeout=0)
 Construction of the class FileType. More...
 
 FileType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL, OpcUa_UInt32 clientProcessingTimeout=0)
 Constructs an instance of the class FileType with all components. More...
 
virtual void setInvalid ()
 Set the file object invalid. More...
 
UaString filePath () const
 Get the file path and name used for this FileType object.
 
bool setFilePath (const UaString &sFilePath)
 Set file path and name used for FileType object. More...
 
OpcUa_UInt64 maxFileSize () const
 Get maximum file size accepted for writing. More...
 
void setMaxFileSize (OpcUa_UInt64 maxFileSize)
 Set the maximum file size accepted for writing. More...
 
virtual UaStatus Close (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle)
 Closes a file represented by a FileType. More...
 
virtual UaStatus GetPosition (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, OpcUa_UInt64 &Position)
 Provides the current position of the FileHandle. More...
 
virtual UaStatus Open (const ServiceContext &serviceContext, OpcUa_Byte Mode, OpcUa_UInt32 &FileHandle)
 Opens a file represented by an Object of FileType. More...
 
virtual UaStatus Read (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, OpcUa_Int32 Length, UaByteString &Data)
 Reads a part of the file starting from the current file position. More...
 
virtual UaStatus SetPosition (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, OpcUa_UInt64 Position)
 Sets the current position of the FileHandle. More...
 
virtual UaStatus Write (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, UaByteString &Data)
 Writes a part of the file starting from the current file position. More...
 
OpcUa_UInt32 getClientProcessingTimeout () const
 Return the maximum time in milliseconds a client can keep a file open without working on it. More...
 
void setClientProcessingTimeout (OpcUa_UInt32 milliseconds)
 Set the maximum time in milliseconds a client can keep a file open without working on it. More...
 
void checkTimeout ()
 Check the timeout of open file handles and close the handles if timed out.
 
- Public Member Functions inherited from OpcUa::FileTypeBase
 FileTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an FileType object using an instance declaration node as base.
 
 FileTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an FileType object.
 
 FileTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class FileTypeBase with all components. More...
 
virtual UaNodeId typeDefinitionId () const
 Returns the type definition NodeId for the FileType.
 
virtual UaStatus beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments)
 Call method of an UA object. More...
 
virtual UaStatus call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag)
 Synchronous version of the MethodManager method call executed in a worker thread.
 
virtual void setMimeType (const UaString &MimeType)
 Sets the MimeType value. More...
 
virtual UaString getMimeType () const
 Returns the value of MimeType. More...
 
virtual void setOpenCount (OpcUa_UInt16 OpenCount)
 Sets the OpenCount value. More...
 
virtual OpcUa_UInt16 getOpenCount () const
 Returns the value of OpenCount. More...
 
virtual void setSize (OpcUa_UInt64 Size)
 Sets the Size value. More...
 
virtual OpcUa_UInt64 getSize () const
 Returns the value of Size. More...
 
virtual void setUserWritable (OpcUa_Boolean UserWritable)
 Sets the UserWritable value. More...
 
virtual OpcUa_Boolean getUserWritable () const
 Returns the value of UserWritable. More...
 
virtual void setWritable (OpcUa_Boolean Writable)
 Sets the Writable value. More...
 
virtual OpcUa_Boolean getWritable () const
 Returns the value of Writable. More...
 
virtual OpcUa::PropertyTypegetMimeTypeNode ()
 Returns the MimeType node. More...
 
virtual const OpcUa::PropertyTypegetMimeTypeNode () const
 Returns the MimeType node. More...
 
virtual OpcUa::PropertyTypegetOpenCountNode ()
 Returns the OpenCount node. More...
 
virtual const OpcUa::PropertyTypegetOpenCountNode () const
 Returns the OpenCount node. More...
 
virtual OpcUa::PropertyTypegetSizeNode ()
 Returns the Size node. More...
 
virtual const OpcUa::PropertyTypegetSizeNode () const
 Returns the Size node. More...
 
virtual OpcUa::PropertyTypegetUserWritableNode ()
 Returns the UserWritable node. More...
 
virtual const OpcUa::PropertyTypegetUserWritableNode () const
 Returns the UserWritable node. More...
 
virtual OpcUa::PropertyTypegetWritableNode ()
 Returns the Writable node. More...
 
virtual const OpcUa::PropertyTypegetWritableNode () const
 Returns the Writable node. More...
 
virtual OpcUa::BaseMethodgetClose ()
 Returns the Close node.
 
virtual const OpcUa::BaseMethodgetClose () const
 Returns the Close node.
 
virtual OpcUa::BaseMethodgetGetPosition ()
 Returns the GetPosition node.
 
virtual const OpcUa::BaseMethodgetGetPosition () const
 Returns the GetPosition node.
 
virtual OpcUa::BaseMethodgetOpen ()
 Returns the Open node.
 
virtual const OpcUa::BaseMethodgetOpen () const
 Returns the Open node.
 
virtual OpcUa::BaseMethodgetRead ()
 Returns the Read node.
 
virtual const OpcUa::BaseMethodgetRead () const
 Returns the Read node.
 
virtual OpcUa::BaseMethodgetSetPosition ()
 Returns the SetPosition node.
 
virtual const OpcUa::BaseMethodgetSetPosition () const
 Returns the SetPosition node.
 
virtual OpcUa::BaseMethodgetWrite ()
 Returns the Write node.
 
virtual const OpcUa::BaseMethodgetWrite () const
 Returns the Write node.
 
virtual void useAccessInfoFromType ()
 Applys the NodeAccessInfo set at the FileTypeBase and its children. More...
 
void useAccessInfoFromInstance (FileTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- Public Member Functions inherited from OpcUa::BaseObjectType
 BaseObjectType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
 BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
UaReferenceListsgetUaReferenceLists () const
 Get the UaReferenceLists interface for the node. More...
 
virtual UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
UaNodeId nodeId () const
 Get the NodeId of the current Node. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName of the current Node. More...
 
virtual UaLocalizedText displayName (Session *pSession) const
 Get the displayName as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isDescriptionSupported () const
 Check if Node is DescriptionSupported. More...
 
virtual UaLocalizedText description (Session *pSession) const
 Get the description as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isWriteMaskSupported () const
 Check if Node is WriteMaskSupported. More...
 
virtual OpcUa_UInt32 writeMask () const
 Get the writeMask of the current Node. More...
 
virtual OpcUa_Boolean isUserWriteMaskSupported () const
 Check if Node is UserWriteMaskSupported. More...
 
virtual OpcUa_UInt32 userWriteMask (Session *pSession) const
 Check if Node has a userWriteMask. More...
 
UaNodegetUaNode () const
 Get the UaNode interface pointer of this node. More...
 
virtual OpcUa_Byte eventNotifier () const
 Returns the EventNotifier for the BaseObjectType. More...
 
virtual MethodManagergetMethodManager (UaMethod *pMethod) const
 Returns the method manager interface for the BaseObjectType instance. More...
 
virtual void setUserData (UserDataBase *pUserData)
 Method to set user data stored in this class. More...
 
virtual UserDataBasegetUserData () const
 Method to get the user data stored in this class. More...
 
virtual void setBrowseName (const UaQualifiedName &browseName)
 Sets the browse name attribute value. More...
 
virtual void setDisplayName (const UaLocalizedText &displayName)
 Sets the display name attribute value. More...
 
virtual void setDescription (const UaLocalizedText &description)
 Sets the description attribute value. More...
 
virtual void setWriteMask (OpcUa_UInt32 writeMask)
 Sets the write mask attribute value. More...
 
virtual void setEventNotifier (OpcUa_Byte eventNotifier)
 Sets the eventNotifier attribute value. More...
 
virtual void setModellingRuleId (const UaNodeId &modellingRuleId)
 Set NodeId of the modeling rule for this node. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
void setMethodManager (MethodManager *pMethodManager)
 Allows a class aggregating the object to implement the MethodManager for this object. More...
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, NodeAccessInfo *pDefaultPermissions, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from MethodManager
 MethodManager ()
 construction
 
virtual ~MethodManager ()
 destruction
 
- Public Member Functions inherited from UaObject
 UaObject (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaObject. More...
 
OpcUa_NodeClass nodeClass () const
 Get the node class of the Node. More...
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, NodeAccessInfo *pDefaultPermissions, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
virtual bool hasAccessInfo () const
 Check if this UaNode has a NodeAccessInfo assigned. More...
 
virtual void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
virtual void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
virtual void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
- Public Member Functions inherited from ChainEntry
 ChainEntry ()
 construction
 
ChainEntryfind (const UaNodeId &key, ChainEntry **ppPrevious)
 finds the right entry in the chain. More...
 
void add (ChainEntry *pNewEntry)
 adds a new entry to the list. More...
 
void prepend (ChainEntry *pNewEntry)
 prepends a new entry to the list. More...
 
ChainEntryremove (const UaNodeId &key, ChainEntry **ppNext)
 removes an entry from the list. More...
 
ChainEntrygetNext () const
 Check if there is a chain. More...
 
void clearChain ()
 Clear the chain when the hashtable is cleared.
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 
- Public Member Functions inherited from UaReferenceLists
 UaReferenceLists ()
 Constructs the reference lists object.
 
virtual ~UaReferenceLists ()
 Destroys the reference lists object.
 
virtual UaStatus browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaStatus translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
 Find a node based on an element of an relative path. More...
 
virtual const UaReferencepTargetNodes () const
 Returns the list of references to target nodes. More...
 
virtual const UaReferencepSourceNodes () const
 Returns the list of references to source nodes. More...
 
virtual UaNodegetTargetNodeByBrowseName (const UaQualifiedName &browseName) const
 Searches a target node with the passed browse name and returns the UaNode interface if found. More...
 
virtual void addTargetNode (UaReference *pReference)
 Add a reference to a target node where this node is the source node. More...
 
virtual void addSourceNode (UaReference *pReference)
 Adds a reference to a source node where this node is the target node. More...
 
virtual UaStatus removeSourceNode (UaReference *pReferenceToRemove)
 Remove a reference to a source node where this node is the target node. More...
 
virtual bool removeSourceReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a source node. More...
 
virtual UaStatus removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual UaStatus removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual bool removeTargetReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a target node. More...
 
virtual UaStatus removeCrossNodeManagerRef (NodeManager *pNodeManager)
 Remove references to another NodeManager. More...
 
virtual UaStatus invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
 Set all references from SourceNodes to this Node invalid. More...
 
virtual UaStatus invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
 Set all references to TargetNode of this node invalid. More...
 
virtual UaStatus deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
 Deletes all child nodes. More...
 

Static Public Member Functions

static void createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::FileTypeBase
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::BaseObjectType
static void clearStaticMembers ()
 Clear the static members of the class.
 

Protected Member Functions

virtual ~FileType ()
 Destruction.
 
virtual UaFilecreateFileAccessObject (Session *pSession, const UaString &sFileName)
 Creates an object with the interface UaFile used to access the file. More...
 
virtual OpcUa_Boolean checkUserAccess (Session *pSession, UaIODevice::OpenMode openMode)
 Verifies the open mode with the user rights for the file. More...
 
- Protected Member Functions inherited from OpcUa::FileTypeBase
virtual ~FileTypeBase ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::BaseObjectType
virtual ~BaseObjectType ()
 Destruction of the BaseObjectType. More...
 
- Protected Member Functions inherited from UaObject
virtual ~UaObject ()
 Destruction of the UaObject. More...
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 
- Protected Member Functions inherited from UaReferenceLists
virtual UaStatus collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection, int recursionCounter=0)
 Collect a list of all child nodes. More...
 

Additional Inherited Members

- Protected Attributes inherited from UaReferenceLists
UaReferencem_pTargetNodes
 List of references to target nodes where this node is the source node. More...
 
UaReferencem_pLastTargetNode
 Last references in the list of references to the target nodes. More...
 
UaReferencem_pSourceNodes
 List of references to source nodes where this node is the target node. More...
 

Detailed Description

Class implementing the UaObject interface for the FileType.

OPC UA Objects are used to represent systems, system components, real-world objects and software objects. They have the NodeClass Object. The detailed description of Objects and their attributes can be found in the general description of the Object node class.

Variable members of the FileType:

Browse Name DataType TypeDefinition Modelling Rule See Also
MimeType String PropertyType Optional getMimeType, setMimeType
OpenCount UInt16 PropertyType Mandatory getOpenCount, setOpenCount
Size UInt64 PropertyType Mandatory getSize, setSize
UserWritable Boolean PropertyType Mandatory getUserWritable, setUserWritable
Writable Boolean PropertyType Mandatory getWritable, setWritable

Method members of the FileType:

Browse Name Modelling Rule
Close Mandatory
GetPosition Mandatory
Open Mandatory
Read Mandatory
SetPosition Mandatory
Write Mandatory

This ObjectType defines a type for files.

The FileType is used to give an OPC UA client access to a file managed by the OPC UA server. After creating a FileType object in the server, the path to the file can be set with FileType::setFilePath.

The class implements the interface to OPC UA clients. It automatically handles the closing of the file if the session of a client is closed that has a file open.

In addition an additional application timeout can be set to avoid that a client with a valid session keeps a file open too long. This is a SDK specific feature provided through setClientProcessingTimeout(). The timeout is reset with every client operation like Read, Writer or SetPosition.

By default the FileType uses the class UaFile for all file access operations. The default behaviour of UaFile can be changed by overwriting FileType::createFileAccessObject. This allows to create a own implementation of UaFile with the application specific behaviour.

The maximum size of the file a client can write to can be limited with FileType::setMaxFileSize. The write access can be set with FileTypeBase::setWritable.

Note that all Methods on a file require a FileHandle, which is returned in the Open Method.

See also FileType for a documentation of the complete Information Model.

Constructor & Destructor Documentation

OpcUa::FileType::FileType ( const UaNodeId nodeId,
UaObject pInstanceDeclarationObject,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL,
OpcUa_UInt32  clientProcessingTimeout = 0 
)

Construction of the class FileType.

This constructor is used if the object is created based on an instance declaration of an object type. Since the only difference between the instance declaration object and the instance object are the node id, the pointer to the instance declaration node is used to get the attribute values other than NodeId from the instance declaration node.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]pInstanceDeclarationObjectUaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
[in]clientProcessingTimeoutTimeout how long a file may be kept open without working on it
OpcUa::FileType::FileType ( const UaNodeId nodeId,
const UaString name,
OpcUa_UInt16  browseNameNameSpaceIndex,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL,
OpcUa_UInt32  clientProcessingTimeout = 0 
)

Construction of the class FileType.

This constructor is used if the object is not created based on an instance declaration. It defines the name and node id of the object. Additional language specific names and other attribute values can be set with set methods provided by the class.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]nameName of the new object. Used as browse name and also as display name if no additional language specific names are set.
[in]browseNameNameSpaceIndexNamespace index used for the browse name
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
[in]clientProcessingTimeoutTimeout how long a file may be kept open without working on it
OpcUa::FileType::FileType ( UaBase::Object pBaseNode,
XmlUaNodeFactoryManager pFactory,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL,
OpcUa_UInt32  clientProcessingTimeout = 0 
)

Constructs an instance of the class FileType with all components.

Parameters
[in]pBaseNodeThe "tree" of nodes that specifies the attributes of the instance and its children
[in]pFactoryThe factory to create the children
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided
[in]clientProcessingTimeoutTimeout how long a file may be kept open without working on it

Member Function Documentation

OpcUa_Boolean OpcUa::FileType::checkUserAccess ( Session pSession,
UaIODevice::OpenMode  openMode 
)
protectedvirtual

Verifies the open mode with the user rights for the file.

The default implementation checks if the user has call permission for the Write method if the OpenMode Write is requested.

By overwriting this method, the derived class can control access on user level. If the user has not the full rights for the requested openMode, the method returns false.

UaStatus OpcUa::FileType::Close ( const ServiceContext serviceContext,
OpcUa_UInt32  FileHandle 
)
virtual

Closes a file represented by a FileType.

When a client closes a file, the handle becomes invalid.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]FileHandleA handle returned by the Open method, indicating the access request and thus indirectly the position inside the file.

Implements OpcUa::FileTypeBase.

Reimplemented in OpcUa::TrustListType.

UaFile * OpcUa::FileType::createFileAccessObject ( Session pSession,
const UaString sFileName 
)
protectedvirtual

Creates an object with the interface UaFile used to access the file.

The default implementation creates an instance of UaFile. By overwriting this method, the derived class can create an object that has a specialized implementation of UaFile. The passed in session context can be used to control access on user level.

Parameters
[in]pSessionSession context used to access the file. This parameter is only relevant if this method is overwritten by a derived class.
[in]sFileNameName and path of the file to access.

Reimplemented in OpcUa::TrustListType.

OpcUa_UInt32 OpcUa::FileType::getClientProcessingTimeout ( ) const

Return the maximum time in milliseconds a client can keep a file open without working on it.

0 means unlimited.

UaStatus OpcUa::FileType::GetPosition ( const ServiceContext serviceContext,
OpcUa_UInt32  FileHandle,
OpcUa_UInt64 &  Position 
)
virtual

Provides the current position of the FileHandle.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]FileHandleA handle returned by the Open method, indicating the access request and thus indirectly the position inside the file.
[out]PositionThe position of the FileHandle in the file.
If Read or Write is called, it starts at that position.

Implements OpcUa::FileTypeBase.

OpcUa_UInt64 OpcUa::FileType::maxFileSize ( ) const

Get maximum file size accepted for writing.

Default value 0 is unlimited.

UaStatus OpcUa::FileType::Open ( const ServiceContext serviceContext,
OpcUa_Byte  Mode,
OpcUa_UInt32 &  FileHandle 
)
virtual

Opens a file represented by an Object of FileType.

When a client opens a file, it gets a FileHandle that is valid while the session is open. Clients shall use the Close Method to release the handle when they do not need access to the file anymore. Clients can open the same file several times for reading. A request to open for writing shall return Bad_NotWritable when the file is already opened.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]ModeIndicates whether the file should be opened only for read operations or for read and write operations and where the initial position is set.
The mode is an 8-bit unsigned integer used as bit mask with the structure defined in the following table:
Field Bit Description
Read 0 The file is opened for reading. If this bit is not set the Read Method cannot be executed.
Write 1 The file is opened for writing. If this bit is not set the Write Method cannot be executed.
EraseExisting 2 This bit can only be set if the file is opened for writing (Write bit is set). The existing content of the file is erased and an empty file is provided.
Append 3 When the Append bit is set the file is opened at end of the file, otherwise at begin of the file. The SetPosition Method can be used to change the position.
[out]FileHandleA handle for the file used in other method calls indicating not the file (this is done by the Object of the Method call) but the access request and thus the position in the file.
The FileHandle is generated by the server and is unique for the Session. Clients cannot transfer the FileHandle to another Session but need to get a new FileHandle by calling the Open Method.

Implements OpcUa::FileTypeBase.

Reimplemented in OpcUa::TrustListType.

UaStatus OpcUa::FileType::Read ( const ServiceContext serviceContext,
OpcUa_UInt32  FileHandle,
OpcUa_Int32  Length,
UaByteString Data 
)
virtual

Reads a part of the file starting from the current file position.

The file position is advanced by the number of bytes read.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]FileHandleA handle returned by the Open method, indicating the access request and thus indirectly the position inside the file.
[in]LengthDefines the length in bytes that should be returned in data, starting from the current position of the file handle.
If the end of file is reached, all data until the end of the file is returned. The Server is allowed to return less data than the specified length. Only positive values are allowed.
[out]DataContains the returned data of the file.
If the ByteString is empty, it indicates that the end of the file is reached.

Implements OpcUa::FileTypeBase.

void OpcUa::FileType::setClientProcessingTimeout ( OpcUa_UInt32  milliseconds)

Set the maximum time in milliseconds a client can keep a file open without working on it.

Default value 0 is unlimited.

bool OpcUa::FileType::setFilePath ( const UaString sFilePath)

Set file path and name used for FileType object.

Parameters
[in]sFilePathFile path and name of the file to represent.
void OpcUa::FileType::setInvalid ( )
virtual

Set the file object invalid.

This method is called from the NodeManagerUaNode when the file object is deleted

Reimplemented from ChainEntry.

void OpcUa::FileType::setMaxFileSize ( OpcUa_UInt64  maxFileSize)

Set the maximum file size accepted for writing.

Default value 0 is unlimited.

Parameters
[in]maxFileSizeMaximum file size to accept for writing.
UaStatus OpcUa::FileType::SetPosition ( const ServiceContext serviceContext,
OpcUa_UInt32  FileHandle,
OpcUa_UInt64  Position 
)
virtual

Sets the current position of the FileHandle.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]FileHandleA handle indicating the access request and thus indirectly the position inside the file.
[in]PositionThe position to be set for the FileHandle in the file.
If Read or Write is called, it starts at that position. If the position is higher than the file size, the position is set to the end of the file.

Implements OpcUa::FileTypeBase.

UaStatus OpcUa::FileType::Write ( const ServiceContext serviceContext,
OpcUa_UInt32  FileHandle,
UaByteString Data 
)
virtual

Writes a part of the file starting from the current file position.

The file position is advanced by the number of bytes written

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]FileHandleA handle returned by the Open method, indicating the access request and thus indirectly the position inside the file.
[in]DataContains the data to be written at the position of the file.
It is server-dependent whether the written data are persistently stored if the session is ended without calling the Close Method with the FileHandle.
Writing an empty or null ByteString returns a Good result code without any effect on the file.

Implements OpcUa::FileTypeBase.


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