/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2011-2012 Couchbase, Inc.
 *
 *   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.
 */

/**
 * @file
 * libevent integration with libcouchbase
 * @author Trond Norbye
 */

/**
 * @ingroup lcb-io-plugin-api
 * @defgroup lcb-libevent libevent
 * @brief libev integration
 *
 * lcb_create_libevent_io_opts() allows you to create an instance
 * of the ioopts that will utilize libevent. You may either supply an event
 * base (if you'd like to add your own events into the loop), or it will
 * create its own.
 */

/**
 * @addtogroup lcb-libevent
 * @{
 */
#ifndef LIBCOUCHBASE_LIBEVENT_IO_OPTS_H
#define LIBCOUCHBASE_LIBEVENT_IO_OPTS_H 1

#include <libcouchbase/couchbase.h>

#ifdef __cplusplus
extern "C" {
#endif

    /**
     * Create an instance of an event handler that utilize libevent for
     * event notification.
     *
     * @param version the API version to use
     * @param base the event base (struct event_base *) to hook use (please
     *             note that you shouldn't reference the event base from
     *             multiple threads)
     * @param io a pointer to a newly created and initialized event handler
     * @return status of the operation
     */
    LIBCOUCHBASE_API
    lcb_error_t lcb_create_libevent_io_opts(int version, lcb_io_opt_t *io, void *base);

#ifdef __cplusplus
}
#endif

/**@}*/
#endif
