/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You 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.

 */

#ifndef _LOG4CXX_NET_SOCKET_APPENDER_SKELETON_H

#define _LOG4CXX_NET_SOCKET_APPENDER_SKELETON_H

#include <log4cxx/appenderskeleton.h>

#include <log4cxx/helpers/socket.h>

#include <thread>

#include <condition_variable>

namespace LOG4CXX_NS

{

namespace net

{

/**

 *  Abstract base class for SocketAppender and XMLSocketAppender

 */

class LOG4CXX_EXPORT SocketAppenderSkeleton : public AppenderSkeleton

{

  protected:

    struct SocketAppenderSkeletonPriv;

  public:

    SocketAppenderSkeleton(int defaultPort, int reconnectionDelay);

    ~SocketAppenderSkeleton();

    /**

    Connects to remote server at <code>address</code> and <code>port</code>.

    */

    SocketAppenderSkeleton(helpers::InetAddressPtr address, int port, int reconnectionDelay);

    /**

    Connects to remote server at <code>host</code> and <code>port</code>.

    */

    SocketAppenderSkeleton(const LogString& host, int port, int reconnectionDelay);

    /**

    \copybrief AppenderSkeleton::activateOptions()

    Connects to the specified <b>RemoteHost</b> and <b>Port</b>.

    */

    void activateOptions(helpers::Pool& p) override;

    void close() override;

    /**

    * This appender does not use a layout. Hence, this method

    * returns <code>false</code>.

    *

         */

    bool requiresLayout() const override

    {

      return false;

    }

    /**

    * The <b>RemoteHost</b> option takes a string value which should be

    * the host name of the server where a

    * Apache Chainsaw or compatible is running.

    * */

    void setRemoteHost(const LogString& host);

    /**

    Returns value of the <b>RemoteHost</b> option.

    */

    const LogString& getRemoteHost() const;

    /**

    The <b>Port</b> option takes a positive integer representing

    the port where the server is waiting for connections.

    */

    void setPort(int port1);

    /**

    Returns value of the <b>Port</b> option.

    */

    int getPort() const;

    /**

    The <b>LocationInfo</b> option takes a boolean value. If true,

    the information sent to the remote host will include location

    information. By default no location information is sent to the server.

    */

    void setLocationInfo(bool locationInfo1);

    /**

    Returns value of the <b>LocationInfo</b> option.

    */

    bool getLocationInfo() const;

    /**

    The <b>ReconnectionDelay</b> option takes a positive integer

    representing the number of milliseconds to wait between each

    failed connection attempt to the server. The default value of

    this option is 30000 which corresponds to 30 seconds.

    <p>Setting this option to zero turns off reconnection

    capability.

    */

    void setReconnectionDelay(int reconnectionDelay1);

    /**

    Returns value of the <b>ReconnectionDelay</b> option.

    */

    int getReconnectionDelay() const;

    void fireConnector();

    /**

    \copybrief AppenderSkeleton::setOption()

    Supported options | Supported values | Default value

    -------------- | ---------------- | ---------------

    RemoteHost |  (\ref inetAddress "1") | -

    Port | {int} | (\ref defaultPort "2")

    LocationInfo | True,False | False

    \anchor inetAddress (1) A valid internet address.

    \anchor defaultPort (2) Provided by the derived class.

    \sa AppenderSkeleton::setOption()

    */

    void setOption(const LogString& option, const LogString& value) override;

  protected:

    SocketAppenderSkeleton(std::unique_ptr<SocketAppenderSkeletonPriv> priv);

    virtual void setSocket(LOG4CXX_NS::helpers::SocketPtr& socket, LOG4CXX_NS::helpers::Pool& p) = 0;

    virtual void cleanUp(LOG4CXX_NS::helpers::Pool& p) = 0;

    virtual int getDefaultDelay() const = 0;

    virtual int getDefaultPort() const = 0;

  private:

    void connect(LOG4CXX_NS::helpers::Pool& p);

    /**

         The Connector will reconnect when the server becomes available

         again.  It does this by attempting to open a new connection every

         <code>reconnectionDelay</code> milliseconds.

         <p>It stops trying whenever a connection is established. It will

         restart to try reconnect to the server when previously open

         connection is droppped.

         */

    void retryConnect();

    bool is_closed();

    SocketAppenderSkeleton(const SocketAppenderSkeleton&);

    SocketAppenderSkeleton& operator=(const SocketAppenderSkeleton&);

}; // class SocketAppenderSkeleton

} // namespace net

} // namespace log4cxx

#endif // _LOG4CXX_NET_SOCKET_APPENDER_SKELETON_H