SocketConnection.h

Go to the documentation of this file.

/*******************************************
Socket Connection internal include file
*******************************************/
#ifndef __KINESIS_VIDEO_WEBRTC_SOCKET_CONNECTION__
#define __KINESIS_VIDEO_WEBRTC_SOCKET_CONNECTION__
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SOCKET_SEND_RETRY_TIMEOUT_MILLI_SECOND 500
#define MAX_SOCKET_WRITE_RETRY                 3
 
#define CLOSE_SOCKET_IF_CANT_RETRY(e, ps)                                                                                                            \
    if ((e) != EAGAIN && (e) != EWOULDBLOCK && (e) != EINTR && (e) != EINPROGRESS && (e) != EPERM && (e) != EALREADY && (e) != ENETUNREACH) {        \
        DLOGD("Close socket %d", (ps)->localSocket);                                                                                                 \
        ATOMIC_STORE_BOOL(&(ps)->connectionClosed, TRUE);                                                                                            \
    }
 
typedef STATUS (*ConnectionDataAvailableFunc)(UINT64, struct __SocketConnection*, PBYTE, UINT32, PKvsIpAddress, PKvsIpAddress);
 
typedef struct __SocketConnection SocketConnection;
struct __SocketConnection {
    /* Indicate whether this socket is marked for cleanup */
    volatile ATOMIC_BOOL connectionClosed;
    /* Process incoming bits */
    volatile ATOMIC_BOOL receiveData;
 
    /* Socket is in use and can't be freed */
    volatile ATOMIC_BOOL inUse;
 
    INT32 localSocket;
    KVS_SOCKET_PROTOCOL protocol;
    KvsIpAddress peerIpAddr;
    KvsIpAddress hostIpAddr;
 
    BOOL secureConnection;
    PTlsSession pTlsSession;
    PDtlsSession pDtlsSession;
 
    MUTEX lock;
 
    ConnectionDataAvailableFunc dataAvailableCallbackFn;
    UINT64 dataAvailableCallbackCustomData;
    UINT64 tlsHandshakeStartTime;
 
    /* Hostname for TLS verification */
    PCHAR hostname;
};
typedef struct __SocketConnection* PSocketConnection;
 
STATUS createSocketConnection(KVS_IP_FAMILY_TYPE, KVS_SOCKET_PROTOCOL, PKvsIpAddress, PKvsIpAddress, UINT64, ConnectionDataAvailableFunc, UINT32,
                              PSocketConnection*);
 
STATUS freeSocketConnection(PSocketConnection*);
 
STATUS socketConnectionInitSecureConnection(PSocketConnection, BOOL, TIMER_QUEUE_HANDLE);
 
STATUS socketConnectionSendData(PSocketConnection, PBYTE, UINT32, PKvsIpAddress);
 
STATUS socketConnectionReadData(PSocketConnection, PBYTE, UINT32, PUINT32);
 
STATUS socketConnectionShutdownSecureSession(PSocketConnection);
 
STATUS socketConnectionClosed(PSocketConnection);
 
BOOL socketConnectionIsClosed(PSocketConnection);
 
BOOL socketConnectionIsConnected(PSocketConnection);
 
// internal functions
STATUS socketSendDataWithRetry(PSocketConnection, PBYTE, UINT32, PKvsIpAddress, PUINT32);
 
// TLS and DTLS session callbacks used by SocketConnection to forward encrypted records and react to handshake state
// changes. These are internal hooks for the secure transport path, not part of the public SocketConnection API.
STATUS socketConnectionTlsSessionOutBoundPacket(UINT64, PBYTE, UINT32);
VOID socketConnectionTlsSessionOnStateChange(UINT64, TLS_SESSION_STATE);
VOID socketConnectionDtlsSessionOnStateChange(UINT64, RTC_DTLS_TRANSPORT_STATE);
VOID socketConnectionDtlsSessionOutBoundPacket(UINT64, PBYTE, UINT32);
 
#ifdef __cplusplus
}
#endif
#endif /* __KINESIS_VIDEO_WEBRTC_SOCKET_CONNECTION__ */