CBLURLEndpointListener.h

Go to the documentation of this file.

//
//  CBLURLEndpointListener.h
//
// Copyright (c) 2025 Couchbase, Inc All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
 
#pragma once
#include "CBLBase.h"
 
#ifdef COUCHBASE_ENTERPRISE
 
#include "CBLTLSIdentity.h"
 
CBL_CAPI_BEGIN

typedef struct CBLListenerAuthenticator CBLListenerAuthenticator;

typedef bool (*CBLListenerPasswordAuthCallback) (
    void* context,              
    FLString username,          
    FLString password           
);

_cbl_warn_unused CBLListenerAuthenticator* CBLListenerAuth_CreatePassword(CBLListenerPasswordAuthCallback auth,
                                                                          void* _cbl_nullable context) CBLAPI;

typedef bool (*CBLListenerCertAuthCallback) (
    void* context,              
    CBLCert* cert               
);

_cbl_warn_unused CBLListenerAuthenticator* CBLListenerAuth_CreateCertificate(CBLListenerCertAuthCallback auth,
                                                                             void* _cbl_nullable context) CBLAPI;

_cbl_warn_unused CBLListenerAuthenticator* CBLListenerAuth_CreateCertificateWithRootCerts(CBLCert* rootCerts) CBLAPI;

void CBLListenerAuth_Free(CBLListenerAuthenticator* _cbl_nullable) CBLAPI;

typedef struct {
    CBLCollection* _cbl_nonnull * _cbl_nonnull collections;

    size_t collectionCount;

    uint16_t port;

    FLString networkInterface;

    bool disableTLS;

    CBLTLSIdentity* _cbl_nullable tlsIdentity;

    CBLListenerAuthenticator* _cbl_nullable authenticator;

    bool enableDeltaSync;

    bool readOnly;
} CBLURLEndpointListenerConfiguration;

typedef struct CBLURLEndpointListener CBLURLEndpointListener;
 
CBL_REFCOUNTED(CBLURLEndpointListener*, URLEndpointListener);

_cbl_warn_unused CBLURLEndpointListener* _cbl_nullable CBLURLEndpointListener_Create(const CBLURLEndpointListenerConfiguration*, CBLError* _cbl_nullable outError) CBLAPI;

const CBLURLEndpointListenerConfiguration* CBLURLEndpointListener_Config(const CBLURLEndpointListener*) CBLAPI;

uint16_t CBLURLEndpointListener_Port(const CBLURLEndpointListener*) CBLAPI;

CBLTLSIdentity* CBLURLEndpointListener_TLSIdentity(const CBLURLEndpointListener*) CBLAPI;

FLMutableArray CBLURLEndpointListener_Urls(const CBLURLEndpointListener*) CBLAPI;

typedef struct {
    uint64_t connectionCount;       
    uint64_t activeConnectionCount; 
} CBLConnectionStatus;

CBLConnectionStatus CBLURLEndpointListener_Status(const CBLURLEndpointListener*) CBLAPI;

bool CBLURLEndpointListener_Start(CBLURLEndpointListener*, CBLError* _cbl_nullable outError) CBLAPI;

void CBLURLEndpointListener_Stop(CBLURLEndpointListener*) CBLAPI;
 
CBL_CAPI_END
 
#endif