1/*
2 * Copyright (c) 2013 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24#ifndef PowerManagement_Platform_h
25#define PowerManagement_Platform_h
26#include "PrivateLib.h"
27
28#if !TARGET_OS_EMBEDDED
29#define TCPKEEPALIVE 1
30#endif
31
32#define kTCPKeepAliveExpireSecs (12*60*60) // 12 hours
33
34typedef enum {
35    kNotSupported = 0,
36    kActive,
37    kInactive,
38} tcpKeepAliveStates_et;
39
40
41typedef struct {
42    int                 qIndex;
43    int                 darkWakesCount;
44    int                 wakeQuota;
45    CFTimeInterval      wakeQuotaInterval;
46    CFAbsoluteTime      *darkWakes;
47    long                overrideSec;
48    tcpKeepAliveStates_et   state;
49    dispatch_source_t   expiration;
50} TCPKeepAliveStruct;
51
52/*! getTCPKeepAliveState
53 *
54 *  @param buf      Upon return, this buffer will contain a string either "active",
55 *                  if TCPKeepAlive is active;
56 *                  or "inactive: <reasons>" with the reason that it's inactive.
57 *                      inactive: expired, quota
58 *                  or "unsupported"
59 *  @result         Returns a state value from enum tcpKeepAliveStates_et
60 */
61__private_extern__ tcpKeepAliveStates_et  getTCPKeepAliveState(char *buf, int buflen);
62
63__private_extern__ void startTCPKeepAliveExpTimer( );
64__private_extern__ void cancelTCPKeepAliveExpTimer( );
65__private_extern__ void startTCPKeepAliveExpTimer( );
66__private_extern__ void cancelTCPKeepAliveExpTimer( );
67#endif
68