summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLProtocolHeader.h
blob: dc8cbb788b8e387fff639aedadf3fb1f3b2483a0 (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
//  SDLProtocolHeader.h
//

#import <Foundation/Foundation.h>


typedef NS_ENUM(UInt8, SDLFrameType) {
    SDLFrameType_Control = 0x00,
    SDLFrameType_Single = 0x01,
    SDLFrameType_First = 0x02,
    SDLFrameType_Consecutive = 0x03
};

typedef NS_ENUM(UInt8, SDLServiceType) {
    SDLServiceType_Control = 0x00,
    SDLServiceType_RPC = 0x07,
    SDLServiceType_Audio = 0x0A,
    SDLServiceType_Video = 0x0B,
    SDLServiceType_BulkData = 0x0F
};

typedef NS_ENUM(UInt8, SDLFrameData) {
    SDLFrameData_Heartbeat = 0x00,
    SDLFrameData_StartSession = 0x01,
    SDLFrameData_StartSessionACK = 0x02,
    SDLFrameData_StartSessionNACK = 0x03,
    SDLFrameData_EndSession = 0x04,
    SDLFrameData_EndSessionACK = 0x05,
    SDLFrameData_EndSessionNACK = 0x06,
    SDLFrameData_ServiceDataACK = 0xFE,
    SDLFrameData_HeartbeatACK = 0xFF,
    // If frameType == Single (0x01)
    SDLFrameData_SingleFrame = 0x00,
    // If frameType == First (0x02)
    SDLFrameData_FirstFrame = 0x00,
    // If frametype == Consecutive (0x03)
    SDLFrameData_ConsecutiveLastFrame = 0x00
};


@interface SDLProtocolHeader : NSObject <NSCopying> {
    UInt8 _version;
    NSUInteger _size;
}

@property (assign, readonly) UInt8 version;
@property (assign, readonly) NSUInteger size;
@property (assign) BOOL compressed __deprecated_msg("This is a mirror for encrypted");
@property (assign) BOOL encrypted;
@property (assign) SDLFrameType frameType;
@property (assign) SDLServiceType serviceType;
@property (assign) SDLFrameData frameData;
@property (assign) UInt8 sessionID;
@property (assign) UInt32 bytesInPayload;

- (instancetype)init;
- (NSData *)data;
- (void)parse:(NSData *)data;
- (NSString *)description;
+ (__kindof SDLProtocolHeader *)headerForVersion:(UInt8)version;

@end