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

#import <Foundation/Foundation.h>


typedef NS_ENUM(UInt8, SDLFrameType) {
    SDLFrameTypeControl = 0x00,
    SDLFrameTypeSingle = 0x01,
    SDLFrameTypeFirst = 0x02,
    SDLFrameTypeConsecutive = 0x03
};

typedef NS_ENUM(UInt8, SDLServiceType) {
    SDLServiceTypeControl = 0x00,
    SDLServiceTypeRPC NS_SWIFT_NAME(rpc) = 0x07,
    SDLServiceTypeAudio = 0x0A,
    SDLServiceTypeVideo = 0x0B,
    SDLServiceTypeBulkData = 0x0F
};

typedef NS_ENUM(UInt8, SDLFrameInfo) {
    SDLFrameInfoHeartbeat = 0x00,
    SDLFrameInfoStartService = 0x01,
    SDLFrameInfoStartServiceACK = 0x02,
    SDLFrameInfoStartServiceNACK = 0x03,
    SDLFrameInfoEndService = 0x04,
    SDLFrameInfoEndServiceACK = 0x05,
    SDLFrameInfoEndServiceNACK = 0x06,
    SDLFrameInfoServiceDataAck = 0xFE,
    SDLFrameInfoHeartbeatACK = 0xFF,
    // If frameType == Single (0x01)
    SDLFrameInfoSingleFrame = 0x00,
    // If frameType == First (0x02)
    SDLFrameInfoFirstFrame = 0x00,
    // If frametype == Consecutive (0x03)
    SDLFrameInfoConsecutiveLastFrame = 0x00
};

NS_ASSUME_NONNULL_BEGIN

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

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

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

@end

NS_ASSUME_NONNULL_END