summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/private/SDLV2ProtocolHeader.m
blob: d91e749264665c810a996ea2ee1cde74bf43c4c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
//  SDLSmartDeviceLinkV2ProtocolHeader.m
//


#import "SDLV2ProtocolHeader.h"

#import "SDLMacros.h"

const int ProtocolV2HeaderByteSize = 12;


@interface SDLV2ProtocolHeader ()

@end


@implementation SDLV2ProtocolHeader

- (instancetype)init {
    // TODO: Should this be changed to whatever the current version is from SDLGlobals
    return [self initWithVersion:2];
}

- (instancetype)initWithVersion:(UInt8)version {
    if (self = [super init]) {
        _version = version;
        _size = ProtocolV2HeaderByteSize;
    }
    return self;
}

- (NSData *)data {
    // Assembles the properties in the binary header format
    Byte headerBytes[ProtocolV2HeaderByteSize] = {0};

    Byte version = (Byte)((self.version & 0xF) << 4); // first 4 bits
    Byte encrypted = (Byte)((self.encrypted ? 1 : 0) << 3); // next 1 bit
    Byte frameType = (self.frameType & 0x7); // last 3 bits

    headerBytes[0] = version | encrypted | frameType;
    headerBytes[1] = self.serviceType;
    headerBytes[2] = self.frameData;
    headerBytes[3] = self.sessionID;

    // Need to write these ints as big-endian.
    UInt32 *p = (UInt32 *)&headerBytes[4];
    *p = CFSwapInt32HostToBig(self.bytesInPayload);

    p = (UInt32 *)&headerBytes[8];
    *p = CFSwapInt32HostToBig(self.messageID);

    // Now put it all in an NSData object.
    NSData *dataOut = [NSData dataWithBytes:headerBytes length:ProtocolV2HeaderByteSize];

    return dataOut;
}

- (id)copyWithZone:(NSZone *)zone {
    SDLV2ProtocolHeader *newHeader = [[SDLV2ProtocolHeader allocWithZone:zone] init];
    newHeader->_version = self.version;
    newHeader.encrypted = self.encrypted;
    newHeader.frameType = self.frameType;
    newHeader.serviceType = self.serviceType;
    newHeader.frameData = self.frameData;
    newHeader.bytesInPayload = self.bytesInPayload;
    newHeader.sessionID = self.sessionID;
    newHeader.messageID = self.messageID;

    return newHeader;
}

- (void)parse:(NSData *)data {
    NSParameterAssert(data != nil);
    NSAssert(data.length >= _size, @"Error: insufficient data available to parse V2 header.");

    Byte *bytePointer = (Byte *)data.bytes;
    Byte firstByte = bytePointer[0];
    self.encrypted = ((firstByte & 8) != 0);
    self.frameType = (firstByte & 7);
    self.serviceType = bytePointer[1];
    self.frameData = bytePointer[2];
    self.sessionID = bytePointer[3];

    UInt32 *uintPointer = (UInt32 *)data.bytes;
    self.bytesInPayload = CFSwapInt32BigToHost(uintPointer[1]); // Data is coming in in big-endian, so swap it.
    self.messageID = CFSwapInt32BigToHost(uintPointer[2]); // Data is coming in in big-endian, so swap it.
}

- (NSString *)description {
    NSString *frameTypeString = nil;
    if (self.frameType >= 0 && self.frameType <= 3) {
        NSArray<NSString *> *frameTypeNames = @[@"Control", @"Single", @"First", @"Consecutive"];
        frameTypeString = frameTypeNames[self.frameType];
    }


    NSString *frameDataString = nil;
    if (self.frameType == SDLFrameTypeControl) {
        if (self.frameData >= 0 && self.frameData <= 5) {
            NSArray *controlFrameDataNames = @[@"Heartbeat", @"StartSession", @"StartSessionACK", @"StartSessionNACK", @"EndSession", @"EndSessionACK", @"EndSessionNACK"];
            frameDataString = controlFrameDataNames[self.frameData];
        } else if (self.frameData == SDLFrameInfoTransportEventUpdate) {
            frameDataString = @"TransportEventUpdate";
        } else {
            frameDataString = @"Reserved";
        }
    } else if (self.frameType == SDLFrameTypeSingle || self.frameType == SDLFrameTypeFirst) {
        frameDataString = @"Reserved";
    } else if (self.frameType == SDLFrameTypeConsecutive) {
        frameDataString = @"Frame#";
    }

    NSMutableString *description = [[NSMutableString alloc] init];
    [description appendFormat:@"Version:%i, encrypted:%i, frameType:%@(%i), serviceType:%i, frameData:%@(%i), sessionID:%i, dataSize:%i, messageID:%i, ",
                              self.version,
                              self.encrypted,
                              frameTypeString,
                              self.frameType,
                              self.serviceType,
                              frameDataString,
                              self.frameData,
                              self.sessionID,
                              (unsigned int)self.bytesInPayload,
                              (unsigned int)self.messageID];
    return description;
}

- (NSUInteger)hash {
    return [super hash] ^ NSUIntRotateCell(self.messageID, NSUIntBitCell / 10);
}

- (BOOL)isEqual:(SDLV2ProtocolHeader *)object {
    return (self.hash == object.hash);
}

@end