cipconnectionmanager.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2009, Rockwell Automation, Inc.
 * All rights reserved.
 *
 ******************************************************************************/
#ifndef OPENER_CIPCONNECTIONMANAGER_H_
#define OPENER_CIPCONNECTIONMANAGER_H_

#include "opener_user_conf.h"
#include "opener_api.h"
#include "typedefs.h"
#include "ciptypes.h"
#include "cipconnectionobject.h"

typedef enum {
  kConnectionManagerGeneralStatusSuccess = 0x00, 
  kConnectionManagerGeneralStatusExtendedStatus = 0x01, 
  kConnectionManagerGeneralStatusResourceUnavailableForUnconnectedSend = 0x02,
  kConnectionManagerGeneralStatusPathSegmentErrorInUnconnectedSend = 0x04,
  kConnectionManagerGeneralStatusErrorInDataSegment = 0x09,
  kConnectionManagerGeneralStatusObjectStateError = 0x0C,
  kConnectionManagerGeneralStatusDeviceStateError = 0x10,
  kConnectionManagerGeneralStatusNotEnoughData = 0x13,
  kConnectionManagerGeneralStatusTooMuchData = 0x15,
} ConnectionManagerGeneralStatus;
typedef enum {
  kConnectionManagerExtendedStatusCodeSuccess = 0x00, 
  kConnectionManagerExtendedStatusCodeErrorConnectionInUseOrDuplicateForwardOpen
    = 0x0100,                                                                              
  kConnectionManagerExtendedStatusCodeErrorTransportClassAndTriggerCombinationNotSupported
    = 0x0103,                                                                                        
  kConnectionManagerExtendedStatusCodeErrorOwnershipConflict = 0x0106, 
  kConnectionManagerExtendedStatusCodeErrorConnectionTargetConnectionNotFound =
    0x0107,                                                                             
  kConnectionManagerExtendedStatusCodeErrorTargetForConnectionNotConfigured =
    0x0110,                                                                           
  kConnectionManagerExtendedStatusCodeRpiNotSupported = 0x0111,
  kConnectionManagerExtendedStatusCodeErrorRpiValuesNotAcceptable = 0x0112, 
  kConnectionManagerExtendedStatusCodeErrorNoMoreConnectionsAvailable = 0x0113, 
  kConnectionManagerExtendedStatusCodeErrorVendorIdOrProductcodeError = 0x0114, 
  kConnectionManagerExtendedStatusCodeErrorDeviceTypeError = 0x0115, 
  kConnectionManagerExtendedStatusCodeErrorRevisionMismatch = 0x0116, 
  kConnectionManagerExtendedStatusCodeNonListenOnlyConnectionNotOpened = 0x0119, 
  kConnectionManagerExtendedStatusCodeTargetObjectOutOfConnections = 0x011A, 
  kConnectionManagerExtendedStatusCodeProductionInhibitTimerGreaterThanRpi =
    0x011B,                                                                          
  kConnectionManagerExtendedStatusCodeTransportClassNotSupported = 0x011C, 
  kConnectionManagerExtendedStatusCodeProductionTriggerNotSuppoerted = 0x011D, 
  kConnectionManagerExtendedStatusCodeDirectionNotSupported = 0x011E, 
  kConnectionManagerExtendedStatusCodeInvalidOToTNetworkConnectionFixVar =
    0x011F,                                                                        
  kConnectionManagerExtendedStatusCodeInvalidTToONetworkConnectionFixVar =
    0x0120,                                                                        
  kConnectionManagerExtendedStatusCodeInvalidOToTNetworkConnectionPriority =
    0x0121,                                                                          
  kConnectionManagerExtendedStatusCodeInvalidTToONetworkConnectionPriority =
    0x0122,                                                                          
  kConnectionManagerExtendedStatusCodeErrorInvalidOToTConnectionType = 0x0123, 
  kConnectionManagerExtendedStatusCodeErrorInvalidTToOConnectionType = 0x0124, 
  kConnectionManagerExtendedStatusCodeInvalidOToTNetworkConnectionRedundantOwner
    = 0x0125,                                                                              
  kConnectionManagerExtendedStatusCodeInvalidConfigurationSize = 0x0126, 
  kConnectionManagerExtendedStatusCodeErrorInvalidOToTConnectionSize = 0x0127, 
  kConnectionManagerExtendedStatusCodeErrorInvalidTToOConnectionSize = 0x0128, 
  kConnectionManagerExtendedStatusCodeInvalidConfigurationApplicationPath =
    0x0129,                                                                         
  kConnectionManagerExtendedStatusCodeInvalidConsumingApplicationPath = 0x012A, 
  kConnectionManagerExtendedStatusCodeInvalidProducingApplicationPath = 0x012B, 
  kConnectionManagerExtendedStatusCodeConfigurationSymbolDoesNotExist = 0x012C,
  kConnectionManagerExtendedStatusCodeConsumingSymbolDoesNotExist = 0x012D,
  kConnectionManagerExtendedStatusCodeProducingSymbolDoesNotExist = 0x012E,
  kConnectionManagerExtendedStatusCodeInconsistentApplicationPathCombo = 0x012F, 
  kConnectionManagerExtendedStatusCodeInconsistentConsumeDataFormat = 0x0130,
  kConnectionManagerExtendedStatusCodeInconsistentProduceDataFormat = 0x0131,
  kConnectionManagerExtendedStatusCodeNullForwardOpenNotSupported = 0x0132,
  kConnectionManagerExtendedStatusCodeConnectionTimeoutMultiplierNotAcceptable
    =
      0x0133,
  kConnectionManagerExtendedStatusCodeMismatchedTToONetworkConnectionFixVar =
    0x0135,
  kConnectionManagerExtendedStatusCodeMismatchedTToONetworkConnectionPriority =
    0x0136,
  kConnectionManagerExtendedStatusCodeMismatchedTransportClass = 0x0137,
  kConnectionManagerExtendedStatusCodeMismatchedTToOProductionTrigger = 0x0138,
  kConnectionManagerExtendedStatusCodeMismatchedTToOProductionInhibitTimeSegment
    = 0x0139,
  kConnectionManagerExtendedStatusCodeConnectionTimedOut = 0x0203,
  kConnectionManagerExtendedStatusCodeUnconnectedRequestTimedOut = 0x0204,
  kConnectionManagerExtendedStatusCodeErrorParameterErrorInUnconnectedSendService
    = 0x0205,                                                                               
  kConnectionManagerExtendedStatusCodeMessageToLargeForUnconnectedSendService =
    0x0206,
  kConnectionManagerExtendedStatusCodeUnconnectedAcknowledgeWithoutReply =
    0x0207,
  kConnectionManagerExtendedStatusCodeNoBufferMemoryAvailable = 0x0301,
  kConnectionManagerExtendedStatusCodeNetworkBandwithNotAvailableForData =
    0x0302,
  kConnectionManagerExtendedStatusCodeNoConsumedConnectionIdFilterAvailable =
    0x0303,
  kConnectionManagerExtendedStatusCodeNotConfiguredToSendScheduledPriorityData
    = 0x0304,
  kConnectionManagerExtendedStatusCodeScheduleSignatureMismatch = 0x0305,
  kConnectionManagerExtendedStatusCodeScheduleSignatureValidationNotPossible =
    0x0306,
  kConnectionManagerExtendedStatusCodePortNotAvailable = 0x0311,
  kConnectionManagerExtendedStatusCodeLinkAddressNotValid = 0x0312,
  kConnectionManagerExtendedStatusCodeErrorInvalidSegmentTypeInPath = 0x0315, 
  kConnectionManagerExtendedStatusCodeForwardCloseServiceConnectionPathMismatch
    = 0x0316,
  kConnectionManagerExtendedStatusCodeSchedulingNotSpecified = 0x0317,
  kConnectionManagerExtendedStatusCodeLinkAddressToSelfInvalid = 0x0318,
  kConnectionManagerExtendedStatusCodeSecondaryResourcesUnavailable = 0x0319,
  kConnectionManagerExtendedStatusCodeRackConnectionAlreadyEstablished = 0x031A,
  kConnectionManagerExtendedStatusCodeModuleConnectionAlreadyEstablished =
    0x031B,
  kConnectionManagerExtendedStatusCodeMiscellaneous = 0x031C,
  kConnectionManagerExtendedStatusCodeRedundantConnectionMismatch = 0x031D,
  kConnectionManagerExtendedStatusCodeNoMoreUserConfigurableLinkConsumerResourcesAvailableInTheProducingModule
    = 0x031E,
  kConnectionManagerExtendedStatusCodeNoUserConfigurableLinkConsumerResourcesConfiguredInTheProducingModule
    = 0x031F,
  kConnectionManagerExtendedStatusCodeNetworkLinkOffline = 0x0800,
  kConnectionManagerExtendedStatusCodeNoTargetApplicationDataAvailable = 0x0810,
  kConnectionManagerExtendedStatusCodeNoOriginatorApplicationDataAvailable =
    0x0811,
  kConnectionManagerExtendedStatusCodeNodeAddressHasChangedSinceTheNetworkWasScheduled
    = 0x0812,
  kConnectionManagerExtendedStatusCodeNotConfiguredForOffSubnetMulticast =
    0x0813,
  kConnectionManagerExtendedStatusCodeInvalidProduceConsumeDataFormat = 0x0814,
  kConnectionManagerExtendedStatusWrongCloser = 0xFFFF /* No a real extended error code, but needed for forward close */
} ConnectionManagerExtendedStatusCode;

#define SEQ_LEQ32(a, b) ( (int)( (a) - (b) ) <= 0 )
#define SEQ_GEQ32(a, b) ( (int)( (a) - (b) ) >= 0 )
#define SEQ_GT32(a, b) ( (int)( (a) - (b) ) > 0 )

#define SEQ_LEQ16(a, b) ( (short)( (a) - (b) ) <= 0 )
#define SEQ_GEQ16(a, b) ( (short)( (a) - (b) ) >= 0 )

static const int g_kCipConnectionManagerClassCode = 0x06;

/* public functions */

EipStatus ConnectionManagerInit(EipUint16 unique_connection_id);

CipConnectionObject *GetConnectedObject(const EipUint32 connection_id);

CipConnectionObject *GetConnectedOutputAssembly(
  const EipUint32 output_assembly_id);

void CloseConnection(CipConnectionObject *RESTRICT connection_object);

/* TODO: Missing documentation */
EipBool8 IsConnectedOutputAssembly(const EipUint32 instance_number);

void AddNewActiveConnection(const CipConnectionObject *const connection_object);

void RemoveFromActiveConnections(CipConnectionObject *const connection_object);


CipUint GetConnectionId(void);

typedef void (*CloseSessionFunction)(const CipConnectionObject *const
                                     connection_object);

void CheckForTimedOutConnectionsAndCloseTCPConnections(
  const CipConnectionObject *const connection_object,
  CloseSessionFunction CloseSessions);

#endif /* OPENER_CIPCONNECTIONMANAGER_H_ */