ADTF_DEVICE_TOOLBOX  3.12.1 (ADTF 3.18.3)
someip_types.h File Reference

Copyright 2024 CARIAD SE. More...

Go to the source code of this file.

Classes

struct  tSomeIpSampleHeader
 This struct describes the SOME/IP sample header which is placed in the beginning of every SOME/IP sample's buffer. More...
 
struct  tSomeIpMessageHeader
 This struct represents the payload header of one SOME/IP (alike) message as defined by the SOME/IP spec. More...
 
struct  tSomeIpSampleHeader
 This struct describes the SOME/IP sample header which is placed in the beginning of every SOME/IP sample's buffer. More...
 
struct  tSomeIpSessionHeader
 This struct represents the first 8 payload bytes of a standard SOME/IP request. More...
 
struct  tSomeIpTpHeader
 This struct represents the next 4 payload bytes of a SOME/IP-TP message. More...
 
union  uLimitType
 Required types for tCompuScale and tDataConstraint vary based on tSomeIpSerializationInfo::tBasicType::nLength and tSomeIpSerializationInfo::tBasicType::nType. More...
 
struct  tDataConstraint
 This struct represents the limits of a value. More...
 
struct  tCompuScale
 This struct represents one of a set of computation rules which map a raw value onto a physical value and/or named states. More...
 
union  tCompuScale::uCompuType
 
struct  tCompuScale::uCompuType::tLinear
 
struct  tCompuScale::uCompuType::tTextConstant
 
struct  tSomeIpSerializationInfo
 Serialization instructions covering SOME/IP standard. More...
 
struct  tSomeIpSerializationInfo::tTLVProperties
 
union  tSomeIpSerializationInfo::uDetails
 
struct  tSomeIpSerializationInfo::uDetails::tBasicType
 
struct  tSomeIpSerializationInfo::uDetails::tArrayType
 
struct  tSomeIpSerializationInfo::uDetails::tStructType
 
struct  tSomeIpSerializationInfo::uDetails::tUnionType
 
struct  tSomeIpSerializationInfo::uDetails::tClassicType
 
struct  tSomeIpTransformation
 Special transformations which must be applied to reconstruct nested payloads. More...
 
union  tSomeIpTransformation::uDetails
 
struct  tSomeIpMessageInfo
 This struct describes the actual payload which is encapsulated in either ethernet frame or result of unpacking a different playload. More...
 
struct  tECUInfo
 This struct contains the data of one ecu. More...
 
struct  tSomeIpSocketMessageInfo
 This struct contains the message id and header id of one SOME/IP message. More...
 
struct  tSomeIpSocket
 
struct  tSomeIpConnectionInfo
 This struct describes the SOME/IP connection info. More...
 
struct  tChannelInfo
 This struct contains the data of one ethernet channel. More...
 
struct  tClusterInfo
 This struct contains the data of one cluster. More...
 

Namespaces

 adtf
 ADTF - Namespace.
 
 adtf::devicetb
 Devicetoolbox - Namespace.
 
 adtf::devicetb::sdk
 Namespace for SDK of ADTF-Devicetoolbox.
 
 adtf::devicetb::sdk::someip
 Namespace for SOME/IP in ADTF-Devicetoolbox.
 
 adtf::devicetb::sdk::someip::brake
 Namespace for functionality provided by V3.1.0.
 
 adtf::devicetb::sdk::someip::hood
 Namespace for functionality provided by V3.7.0.
 

Typedefs

using tMessageType = brake::tMessageType
 The message types as defined by the SOME/IP spec. More...
 
using tReturnCode = brake::tReturnCode
 Return codes as defined by the SOME/IP spec. More...
 
using tSomeIpSampleHeader = hood::tSomeIpSampleHeader
 This struct describes the SOME/IP sample header which is placed in the beginning of every SOME/IP sample's buffer. More...
 
using tSomeIpMessageHeader = hood::tSomeIpMessageHeader
 This struct represents the payload header of one SOME/IP (alike) message as defined by the SOME/IP spec. More...
 
using tSomeIpTpHeader = hood::tSomeIpTpHeader
 This struct represents the next 4 payload bytes of a SOME/IP-TP message. More...
 
using tSomeIpSerializationInfo = hood::tSomeIpSerializationInfo
 Serialization instructions covering SOME/IP standard. More...
 
using tSomeIpTransformation = hood::tSomeIpTransformation
 Special transformations which must be applied to reconstruct nested payloads. More...
 
using tSomeIpSessionHeader = hood::tSomeIpSessionHeader
 This struct represents the first 8 payload bytes of a standard SOME/IP request. More...
 
using tCompuScale = hood::tCompuScale
 This struct represents one of a set of computation rules which map a raw value onto a physical value and/or named states. More...
 
using tDataConstraint = hood::tDataConstraint
 This struct represents the limits of a value. More...
 
using tSomeIpMessageInfo = hood::tSomeIpMessageInfo
 This struct describes the actual payload which is encapsulated in either ethernet frame or result of unpacking a different playload. More...
 
using tClusterInfo = hood::tClusterInfo
 This struct contains the data of one cluster. More...
 

Enumerations

enum class  tMessageType : uint8_t {
  MT_REQUEST = 0x00 , MT_REQUEST_NO_RETURN = 0x01 , MT_NOTIFICATION = 0x02 , MT_RESPONSE = 0x80 ,
  MT_ERROR = 0x81 , MT_REQUEST_ACK = 0x40 , MT_REQUEST_NO_RETURN_ACK = 0x41 , MT_NOTIFICATION_ACK = 0x42 ,
  MT_RESPONSE_ACK = 0xC0 , MT_ERROR_ACK = 0xC1 , MT_TP_REQUEST = 0x20 , MT_TP_REQUEST_NO_RETURN = 0x21 ,
  MT_TP_NOTIFICATION = 0x22 , MT_TP_RESPONSE0 = 0xA0 , MT_TP_ERROR = 0xA1
}
 The message types as defined by the SOME/IP spec. More...
 
enum class  tReturnCode : uint8_t {
  E_OK = 0x00 , E_NOT_OK = 0x01 , E_UNKNOWN_SERVICE = 0x02 , E_UNKNOWN_METHOD = 0x03 ,
  E_NOT_READY = 0x04 , E_NOT_REACHABLE = 0x05 , E_TIMEOUT = 0x06 , E_WRONG_PROTOCOL_VERSION = 0x07 ,
  E_WRONG_INTERFACE_VERSION = 0x08 , E_MALFORMED_MESSAGE = 0x09 , E_WRONG_MESSAGE_TYPE = 0x0a , E_RESERVED_MIN = 0x0b ,
  E_RESERVED_MAX = 0x3f
}
 Return codes as defined by the SOME/IP spec. More...
 

Functions

bool operator!= (const tSomeIpSampleHeader &lhs, const tSomeIpSampleHeader &rhs)
 
bool operator== (const tSomeIpSampleHeader &lhs, const tSomeIpSampleHeader &rhs)
 
bool operator!= (const tSomeIpSampleHeader &lhs, const tSomeIpSampleHeader &rhs)
 
bool operator== (const tSomeIpSampleHeader &lhs, const tSomeIpSampleHeader &rhs)
 
bool operator!= (const tSomeIpSessionHeader &lhs, const tSomeIpSessionHeader &rhs)
 
bool operator== (const tSomeIpSessionHeader &lhs, const tSomeIpSessionHeader &rhs)
 

Detailed Description

Copyright 2024 CARIAD SE.

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 https://mozilla.org/MPL/2.0/.

If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

Definition in file someip_types.h.