client_highlevel.h File Reference

#include <open62541/client.h>

Go to the source code of this file.

Macros
#define	UA_DEFAULT_ATTRIBUTES_DEFINED
#define	HAVE_NODEITER_CALLBACK

Typedefs
typedef UA_Boolean(*	UA_HistoricalIteratorCallback) (UA_Client *client, const UA_NodeId *nodeId, UA_Boolean moreDataAvailable, const UA_ExtensionObject *data, void *callbackContext)
typedef UA_StatusCode(*	UA_NodeIteratorCallback) (UA_NodeId childId, UA_Boolean isInverse, UA_NodeId referenceTypeId, void *handle)

Functions
_UA_BEGIN_DECLS UA_StatusCode	__UA_Client_readAttribute (UA_Client *client, const UA_NodeId *nodeId, UA_AttributeId attributeId, void *out, const UA_DataType *outDataType)
UA_StatusCode	UA_Client_readArrayDimensionsAttribute (UA_Client *client, const UA_NodeId nodeId, size_t *outArrayDimensionsSize, UA_UInt32 **outArrayDimensions)
UA_StatusCode	UA_Client_HistoryRead_raw (UA_Client *client, const UA_NodeId *nodeId, const UA_HistoricalIteratorCallback callback, UA_DateTime startTime, UA_DateTime endTime, UA_String indexRange, UA_Boolean returnBounds, UA_UInt32 numValuesPerNode, UA_TimestampsToReturn timestampsToReturn, void *callbackContext)
UA_StatusCode	UA_Client_HistoryUpdate_insert (UA_Client *client, const UA_NodeId *nodeId, UA_DataValue *value)
UA_StatusCode	UA_Client_HistoryUpdate_replace (UA_Client *client, const UA_NodeId *nodeId, UA_DataValue *value)
UA_StatusCode	UA_Client_HistoryUpdate_update (UA_Client *client, const UA_NodeId *nodeId, UA_DataValue *value)
UA_StatusCode	UA_Client_HistoryUpdate_deleteRaw (UA_Client *client, const UA_NodeId *nodeId, UA_DateTime startTimestamp, UA_DateTime endTimestamp)
UA_StatusCode	__UA_Client_writeAttribute (UA_Client *client, const UA_NodeId *nodeId, UA_AttributeId attributeId, const void *in, const UA_DataType *inDataType)
UA_StatusCode	UA_Client_writeArrayDimensionsAttribute (UA_Client *client, const UA_NodeId nodeId, size_t newArrayDimensionsSize, const UA_UInt32 *newArrayDimensions)
UA_StatusCode	UA_Client_call (UA_Client *client, const UA_NodeId objectId, const UA_NodeId methodId, size_t inputSize, const UA_Variant *input, size_t *outputSize, UA_Variant **output)
UA_StatusCode	UA_Client_addReference (UA_Client *client, const UA_NodeId sourceNodeId, const UA_NodeId referenceTypeId, UA_Boolean isForward, const UA_String targetServerUri, const UA_ExpandedNodeId targetNodeId, UA_NodeClass targetNodeClass)
UA_StatusCode	UA_Client_deleteReference (UA_Client *client, const UA_NodeId sourceNodeId, const UA_NodeId referenceTypeId, UA_Boolean isForward, const UA_ExpandedNodeId targetNodeId, UA_Boolean deleteBidirectional)
UA_StatusCode	UA_Client_deleteNode (UA_Client *client, const UA_NodeId nodeId, UA_Boolean deleteTargetReferences)
UA_StatusCode	__UA_Client_addNode (UA_Client *client, const UA_NodeClass nodeClass, const UA_NodeId requestedNewNodeId, const UA_NodeId parentNodeId, const UA_NodeId referenceTypeId, const UA_QualifiedName browseName, const UA_NodeId typeDefinition, const UA_NodeAttributes *attr, const UA_DataType *attributeType, UA_NodeId *outNewNodeId)
UA_StatusCode	UA_Client_NamespaceGetIndex (UA_Client *client, UA_String *namespaceUri, UA_UInt16 *namespaceIndex)
UA_StatusCode	UA_Client_forEachChildNodeCall (UA_Client *client, UA_NodeId parentNodeId, UA_NodeIteratorCallback callback, void *handle)

Variables
UA_EXPORT const UA_VariableAttributes	UA_VariableAttributes_default
UA_EXPORT const UA_VariableTypeAttributes	UA_VariableTypeAttributes_default
UA_EXPORT const UA_MethodAttributes	UA_MethodAttributes_default
UA_EXPORT const UA_ObjectAttributes	UA_ObjectAttributes_default
UA_EXPORT const UA_ObjectTypeAttributes	UA_ObjectTypeAttributes_default
UA_EXPORT const UA_ReferenceTypeAttributes	UA_ReferenceTypeAttributes_default
UA_EXPORT const UA_DataTypeAttributes	UA_DataTypeAttributes_default
UA_EXPORT const UA_ViewAttributes	UA_ViewAttributes_default

Macro Definition Documentation

UA_DEFAULT_ATTRIBUTES_DEFINED

#define UA_DEFAULT_ATTRIBUTES_DEFINED

Protect against redundant definitions for server/client.

Definition at line 460 of file client_highlevel.h.

HAVE_NODEITER_CALLBACK

#define HAVE_NODEITER_CALLBACK

Definition at line 613 of file client_highlevel.h.

Typedef Documentation

UA_HistoricalIteratorCallback

typedef UA_Boolean(* UA_HistoricalIteratorCallback) (UA_Client *client, const UA_NodeId *nodeId, UA_Boolean moreDataAvailable, const UA_ExtensionObject *data, void *callbackContext)

Definition at line 200 of file client_highlevel.h.

UA_NodeIteratorCallback

typedef UA_StatusCode(* UA_NodeIteratorCallback) (UA_NodeId childId, UA_Boolean isInverse, UA_NodeId referenceTypeId, void *handle)

Iterate over all nodes referenced by parentNodeId by calling the callback function for each child node.

Definition at line 616 of file client_highlevel.h.

Function Documentation

__UA_Client_readAttribute()

_UA_BEGIN_DECLS UA_StatusCode __UA_Client_readAttribute	(	UA_Client *	client,
		const UA_NodeId *	nodeId,
		UA_AttributeId	attributeId,
		void *	out,
		const UA_DataType *	outDataType
	)

This Source Code Form is subject to the terms of the Mozilla Public License, v.

2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Copyright 2015-2018 (c) Fraunhofer IOSB (Author: Julius Pfrommer) Copyright 2015 (c) Oleksiy Vasylyev Copyright 2017 (c) Florian Palm Copyright 2016 (c) Chris Iatrou Copyright 2017 (c) Stefan Profanter, fortiss GmbH Copyright 2017 (c) Frank Meerkötter Copyright 2018 (c) Fabian Arndt Copyright 2018 (c) Peter Rustler, basyskom GmbH Don't call this function, use the typed versions

UA_Client_readArrayDimensionsAttribute()

UA_StatusCode UA_Client_readArrayDimensionsAttribute	(	UA_Client *	client,
		const UA_NodeId	nodeId,
		size_t *	outArrayDimensionsSize,
		UA_UInt32 **	outArrayDimensions
	)

UA_Client_HistoryRead_raw()

UA_StatusCode UA_Client_HistoryRead_raw	(	UA_Client *	client,
		const UA_NodeId *	nodeId,
		const UA_HistoricalIteratorCallback	callback,
		UA_DateTime	startTime,
		UA_DateTime	endTime,
		UA_String	indexRange,
		UA_Boolean	returnBounds,
		UA_UInt32	numValuesPerNode,
		UA_TimestampsToReturn	timestampsToReturn,
		void *	callbackContext
	)

UA_Client_HistoryUpdate_insert()

UA_StatusCode UA_Client_HistoryUpdate_insert	(	UA_Client *	client,
		const UA_NodeId *	nodeId,
		UA_DataValue *	value
	)

UA_Client_HistoryUpdate_replace()

UA_StatusCode UA_Client_HistoryUpdate_replace	(	UA_Client *	client,
		const UA_NodeId *	nodeId,
		UA_DataValue *	value
	)

UA_Client_HistoryUpdate_update()

UA_StatusCode UA_Client_HistoryUpdate_update	(	UA_Client *	client,
		const UA_NodeId *	nodeId,
		UA_DataValue *	value
	)

UA_Client_HistoryUpdate_deleteRaw()

UA_StatusCode UA_Client_HistoryUpdate_deleteRaw	(	UA_Client *	client,
		const UA_NodeId *	nodeId,
		UA_DateTime	startTimestamp,
		UA_DateTime	endTimestamp
	)

__UA_Client_writeAttribute()

UA_StatusCode __UA_Client_writeAttribute	(	UA_Client *	client,
		const UA_NodeId *	nodeId,
		UA_AttributeId	attributeId,
		const void *	in,
		const UA_DataType *	inDataType
	)

Don't call this function, use the typed versions.

UA_Client_writeArrayDimensionsAttribute()

UA_StatusCode UA_Client_writeArrayDimensionsAttribute	(	UA_Client *	client,
		const UA_NodeId	nodeId,
		size_t	newArrayDimensionsSize,
		const UA_UInt32 *	newArrayDimensions
	)

UA_Client_call()

UA_StatusCode UA_Client_call	(	UA_Client *	client,
		const UA_NodeId	objectId,
		const UA_NodeId	methodId,
		size_t	inputSize,
		const UA_Variant *	input,
		size_t *	outputSize,
		UA_Variant **	output
	)

UA_Client_addReference()

UA_StatusCode UA_Client_addReference	(	UA_Client *	client,
		const UA_NodeId	sourceNodeId,
		const UA_NodeId	referenceTypeId,
		UA_Boolean	isForward,
		const UA_String	targetServerUri,
		const UA_ExpandedNodeId	targetNodeId,
		UA_NodeClass	targetNodeClass
	)

UA_Client_deleteReference()

UA_StatusCode UA_Client_deleteReference	(	UA_Client *	client,
		const UA_NodeId	sourceNodeId,
		const UA_NodeId	referenceTypeId,
		UA_Boolean	isForward,
		const UA_ExpandedNodeId	targetNodeId,
		UA_Boolean	deleteBidirectional
	)

UA_Client_deleteNode()

UA_StatusCode UA_Client_deleteNode	(	UA_Client *	client,
		const UA_NodeId	nodeId,
		UA_Boolean	deleteTargetReferences
	)

__UA_Client_addNode()

UA_StatusCode __UA_Client_addNode	(	UA_Client *	client,
		const UA_NodeClass	nodeClass,
		const UA_NodeId	requestedNewNodeId,
		const UA_NodeId	parentNodeId,
		const UA_NodeId	referenceTypeId,
		const UA_QualifiedName	browseName,
		const UA_NodeId	typeDefinition,
		const UA_NodeAttributes *	attr,
		const UA_DataType *	attributeType,
		UA_NodeId *	outNewNodeId
	)

Don't call this function, use the typed versions.

UA_Client_NamespaceGetIndex()

UA_StatusCode UA_Client_NamespaceGetIndex	(	UA_Client *	client,
		UA_String *	namespaceUri,
		UA_UInt16 *	namespaceIndex
	)

Get the namespace-index of a namespace-URI.

Parameters

client	The UA_Client struct for this connection
namespaceUri	The interested namespace URI
namespaceIndex	The namespace index of the URI. The value is unchanged in case of an error

Returns

Indicates whether the operation succeeded or returns an error code

UA_Client_forEachChildNodeCall()

UA_StatusCode UA_Client_forEachChildNodeCall	(	UA_Client *	client,
		UA_NodeId	parentNodeId,
		UA_NodeIteratorCallback	callback,
		void *	handle
	)

Variable Documentation

UA_VariableAttributes_default

UA_EXPORT const UA_VariableAttributes UA_VariableAttributes_default

extern

The default for variables is "BaseDataType" for the datatype, -2 for the valuerank and a read-accesslevel.

UA_VariableTypeAttributes_default

UA_EXPORT const UA_VariableTypeAttributes UA_VariableTypeAttributes_default

extern

UA_MethodAttributes_default

UA_EXPORT const UA_MethodAttributes UA_MethodAttributes_default

extern

Methods are executable by default.

UA_ObjectAttributes_default

UA_EXPORT const UA_ObjectAttributes UA_ObjectAttributes_default

extern

The remaining attribute definitions are currently all zeroed out.

UA_ObjectTypeAttributes_default

UA_EXPORT const UA_ObjectTypeAttributes UA_ObjectTypeAttributes_default

extern

UA_ReferenceTypeAttributes_default

UA_EXPORT const UA_ReferenceTypeAttributes UA_ReferenceTypeAttributes_default

extern

UA_DataTypeAttributes_default

UA_EXPORT const UA_DataTypeAttributes UA_DataTypeAttributes_default

extern

UA_ViewAttributes_default

UA_EXPORT const UA_ViewAttributes UA_ViewAttributes_default

extern