OpENer configuration setup. More...

#include "typedefs.h"
#include "devicedata.h"

Include dependency graph for opener_user_conf.h:

Macros
#define	OPENER_ASSERT(assertion)

#define	OPENER_CIP_NUM_APPLICATION_SPECIFIC_CONNECTABLE_OBJECTS 1
	Identity configuration of the device. More...

#define	OPENER_CIP_NUM_EXLUSIVE_OWNER_CONNS 1
	Define the number of supported exclusive owner connections. Each of these connections has to be configured with the function void configureExclusiveOwnerConnectionPoint(unsigned int pa_unConnNum, unsigned int pa_unOutputAssembly, unsigned int pa_unInputAssembly, unsigned int pa_unConfigAssembly) More...

#define	OPENER_CIP_NUM_EXPLICIT_CONNS 6
	Define the number of supported explicit connections. According to ODVA's PUB 70 this number should be greater than 6. More...

#define	OPENER_CIP_NUM_INPUT_ONLY_CONNS 1
	Define the number of supported input only connections. Each of these connections has to be configured with the function void configureInputOnlyConnectionPoint(unsigned int pa_unConnNum, unsigned int pa_unOutputAssembly, unsigned int pa_unInputAssembly, unsigned int pa_unConfigAssembly) More...

#define	OPENER_CIP_NUM_INPUT_ONLY_CONNS_PER_CON_PATH 3
	Define the number of supported input only connections per connection path. More...

#define	OPENER_CIP_NUM_LISTEN_ONLY_CONNS 1
	Define the number of supported listen only connections. Each of these connections has to be configured with the function void configureListenOnlyConnectionPoint(unsigned int pa_unConnNum, unsigned int pa_unOutputAssembly, unsigned int pa_unInputAssembly, unsigned int pa_unConfigAssembly) More...

#define	OPENER_CIP_NUM_LISTEN_ONLY_CONNS_PER_CON_PATH 3
	Define the number of supported Listen only connections per connection path. More...

#define	OPENER_MESSAGE_DATA_REPLY_BUFFER 100
	The number of bytes used for the buffer that will be used for generating any reply data of messages. There are two uses in OpENer: More...

#define	OPENER_NUMBER_OF_SUPPORTED_SESSIONS 20
	Number of sessions that can be handled at the same time. More...

#define	PC_OPENER_ETHERNET_BUFFER_SIZE 512
	The number of bytes used for the Ethernet message buffer on the pc port. For different platforms it may makes sense to have more than one buffer. More...

Typedefs
typedef unsigned short	in_port_t

Detailed Description

OpENer configuration setup.

This file contains the general application specific configuration for OpENer.

Furthermore you have to specific platform specific network include files. OpENer needs definitions for the following data-types and functions:

struct sockaddr_in
AF_INET
INADDR_ANY
htons
ntohl
inet_addr

Definition in file opener_user_conf.h.

Macro Definition Documentation

#define OPENER_ASSERT ( assertion )

Definition at line 134 of file opener_user_conf.h.

Referenced by AddCipInstances(), CheckAndHandleTcpListenerSocket(), CipEpathGetLogicalValue(), CipEpathSetLogicalValue(), CipStackInit(), ConnectionObjectGetInstanceTypeForAttribute(), ConnectionObjectGetPriority(), ConnectionObjectSetState(), ConnectionWithSameConfigPointExists(), CreateCipClass(), CreateCommonPacketFormatStructure(), CreateUdpSocket(), DoublyLinkedListInsertAfterNode(), DoublyLinkedListInsertAtHead(), DoublyLinkedListInsertAtTail(), DoublyLinkedListInsertBeforeNode(), DoublyLinkedListNodeDestroy(), EncodeSockaddrInfoItemTypeId(), EstablishIoConnection(), ForwardClose(), GetAttributeSingle(), GetElectronicKeyFormat4FromMessage(), GetEncapsulationInactivityTimeout(), GetMicroSeconds(), GetPathDataSegmentSimpleDataWordLength(), GetPathLogicalSegmentElectronicKeyFormat(), GetPathLogicalSegmentExtendedLogicalType(), GetPathLogicalSegmentLogicalFormat(), GetPathLogicalSegmentLogicalType(), GetPathLogicalSegmentSpecialTypeLogicalType(), GetPathNetworkSegmentProductionInhibitTimeInMicroseconds(), GetPathNetworkSegmentProductionInhibitTimeInMilliseconds(), GetPathNetworkSegmentSubtype(), GetPathPortSegmentExtendedPortNumber(), GetPathPortSegmentLinkAddressSize(), GetPathPortSegmentPortIdentifier(), GetPathSegmentType(), GetPathSymbolicSegmentASCIIFormatLength(), GetPathSymbolicSegmentExtendedFormat(), GetRegisteredObject(), HandleConfigData(), InsertAttribute(), InsertService(), ManageConnections(), NotifyClass(), NotifyMessageRouter(), SetPathLogicalSegmentLogicalFormat(), SetPathLogicalSegmentLogicalType(), SetPathPortSegmentPortIdentifier(), SetPathSegmentType(), SetupIoConnectionOriginatorToTargetConnectionPoint(), and SetupIoConnectionTargetToOriginatorConnectionPoint().

#define OPENER_CIP_NUM_APPLICATION_SPECIFIC_CONNECTABLE_OBJECTS 1

Identity configuration of the device.

Define the number of objects that may be used in connections

This number needs only to consider additional objects. Connections to the connection manager object as well as to the assembly object are supported in any case.

Definition at line 38 of file opener_user_conf.h.

#define OPENER_CIP_NUM_EXLUSIVE_OWNER_CONNS 1

Define the number of supported exclusive owner connections. Each of these connections has to be configured with the function void configureExclusiveOwnerConnectionPoint(unsigned int pa_unConnNum, unsigned int pa_unOutputAssembly, unsigned int pa_unInputAssembly, unsigned int pa_unConfigAssembly)

Definition at line 50 of file opener_user_conf.h.

Referenced by CipConnectionObjectListArrayAllocator(), ConfigureExclusiveOwnerConnectionPoint(), GetExclusiveOwnerConnection(), and InitializeIoConnectionData().

#define OPENER_CIP_NUM_EXPLICIT_CONNS 6

Define the number of supported explicit connections. According to ODVA's PUB 70 this number should be greater than 6.

Definition at line 43 of file opener_user_conf.h.

Referenced by CipConnectionObjectListArrayAllocator(), GetFreeExplicitConnection(), and InitializeClass3ConnectionData().

#define OPENER_CIP_NUM_INPUT_ONLY_CONNS 1

Define the number of supported input only connections. Each of these connections has to be configured with the function void configureInputOnlyConnectionPoint(unsigned int pa_unConnNum, unsigned int pa_unOutputAssembly, unsigned int pa_unInputAssembly, unsigned int pa_unConfigAssembly)

Definition at line 57 of file opener_user_conf.h.

Referenced by CipConnectionObjectListArrayAllocator(), ConfigureInputOnlyConnectionPoint(), GetInputOnlyConnection(), and InitializeIoConnectionData().

#define OPENER_CIP_NUM_INPUT_ONLY_CONNS_PER_CON_PATH 3

Define the number of supported input only connections per connection path.

Definition at line 61 of file opener_user_conf.h.

Referenced by GetInputOnlyConnection().

#define OPENER_CIP_NUM_LISTEN_ONLY_CONNS 1

Define the number of supported listen only connections. Each of these connections has to be configured with the function void configureListenOnlyConnectionPoint(unsigned int pa_unConnNum, unsigned int pa_unOutputAssembly, unsigned int pa_unInputAssembly, unsigned int pa_unConfigAssembly)

Definition at line 68 of file opener_user_conf.h.

Referenced by CipConnectionObjectListArrayAllocator(), ConfigureListenOnlyConnectionPoint(), GetListenOnlyConnection(), and InitializeIoConnectionData().

#define OPENER_CIP_NUM_LISTEN_ONLY_CONNS_PER_CON_PATH 3

Define the number of supported Listen only connections per connection path.

Definition at line 72 of file opener_user_conf.h.

Referenced by GetListenOnlyConnection().

#define OPENER_MESSAGE_DATA_REPLY_BUFFER 100

The number of bytes used for the buffer that will be used for generating any reply data of messages. There are two uses in OpENer:

Explicit messages will use this buffer to store the data generated by the request
I/O Connections will use this buffer for the produced data

Definition at line 79 of file opener_user_conf.h.

#define OPENER_NUMBER_OF_SUPPORTED_SESSIONS 20

Number of sessions that can be handled at the same time.

Definition at line 83 of file opener_user_conf.h.

Referenced by CheckAndHandleTcpListenerSocket(), CheckEncapsulationInactivity(), CheckRegisteredSessions(), CloseEncapsulationSessionBySockAddr(), CloseSession(), EncapsulationInit(), EncapsulationShutDown(), GetFreeSessionIndex(), GetSessionFromSocket(), HandleDataOnTcpSocket(), HandleReceivedRegisterSessionCommand(), HandleReceivedUnregisterSessionCommand(), NetworkHandlerInitialize(), RemoveSession(), and RemoveSocketTimerFromList().

#define PC_OPENER_ETHERNET_BUFFER_SIZE 512

The number of bytes used for the Ethernet message buffer on the pc port. For different platforms it may makes sense to have more than one buffer.

This buffer size will be used for any received message. The same buffer is used for the replied explicit message.

Definition at line 151 of file opener_user_conf.h.

Referenced by CheckAndHandleConsumingUdpSockets(), CheckAndHandleUdpGlobalBroadcastSocket(), CheckAndHandleUdpUnicastSocket(), HandleDataOnTcpSocket(), and SendUdpData().

Typedef Documentation

typedef unsigned short in_port_t

Definition at line 27 of file opener_user_conf.h.

Macros

Typedefs

Detailed Description

Macro Definition Documentation

Typedef Documentation