c4Socket.h

Go to the documentation of this file.

//
// c4Socket.h
//
// Copyright 2017-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
#include "c4SocketTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS

 
 
// NOTE: C4Socket used to be a concrete struct containing a single field `nativeHandle`.
// As part of creating the C++ API, this struct declaration was removed so it could be
// declared in c4Struct.hh as a real C++ object.
// To fix client code that accessed `nativeHandle` directly, call `c4Socket_setNativeHandle`
// and/or `c4Socket_setNativeHandle` instead.
 

CBL_CORE_API void c4socket_registerFactory(C4SocketFactory factory) C4API;

CBL_CORE_API void c4Socket_setNativeHandle(C4Socket*, void* C4NULLABLE) C4API;

CBL_CORE_API void* C4NULLABLE c4Socket_getNativeHandle(C4Socket*) C4API;

CBL_CORE_API bool c4socket_gotPeerCertificate(C4Socket* socket, C4Slice certData, C4String hostname) C4API;

CBL_CORE_API void c4socket_gotHTTPResponse(C4Socket* socket, int httpStatus, C4Slice responseHeadersFleece) C4API;

CBL_CORE_API void c4socket_opened(C4Socket* socket) C4API;

CBL_CORE_API void c4socket_closed(C4Socket* socket, C4Error errorIfAny) C4API;

CBL_CORE_API void c4socket_closeRequested(C4Socket* socket, int status, C4String message) C4API;

CBL_CORE_API void c4socket_completedWrite(C4Socket* socket, size_t byteCount) C4API;

CBL_CORE_API void c4socket_received(C4Socket* socket, C4Slice data) C4API;
 
 
NODISCARD CBL_CORE_API C4Socket* c4socket_fromNative(C4SocketFactory factory, void* nativeHandle,
                                                     const C4Address* address) C4API;

NODISCARD CBL_CORE_API C4Socket* c4socket_fromNative2(C4SocketFactory factory, void* nativeHandle,
                                                      const C4Address* address, bool incoming) C4API;

 
C4API_END_DECLS
C4_ASSUME_NONNULL_END