socketappenderskeleton.h

Go to the documentation of this file.

/*
 * 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/inetaddress.h>
#if LOG4CXX_ABI_VERSION <= 15
#include <log4cxx/helpers/socket.h>
#endif
 
 
namespace LOG4CXX_NS
{
 
namespace net
{

class LOG4CXX_EXPORT SocketAppenderSkeleton : public AppenderSkeleton
{
    protected:
        struct SocketAppenderSkeletonPriv;
 
    public:
        SocketAppenderSkeleton(int defaultPort, int reconnectionDelay);
        ~SocketAppenderSkeleton();

#if LOG4CXX_ABI_VERSION <= 15
        SocketAppenderSkeleton(helpers::InetAddressPtr address, int port, int reconnectionDelay);
#else
        SocketAppenderSkeleton(const helpers::InetAddressPtr& address, int port, int reconnectionDelay);
#endif
        SocketAppenderSkeleton(const LogString& host, int port, int reconnectionDelay);
 
        using spi::OptionHandler::activateOptions;
        void activateOptions( LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS ) override;
 
        void close() override;
 
#if LOG4CXX_ABI_VERSION <= 15
        bool requiresLayout() const override
        {
            return false;
        }
#endif
        void setRemoteHost(const LogString& host);

        const LogString& getRemoteHost() const;

        void setPort(int port1);

        int getPort() const;

        void setLocationInfo(bool locationInfo1);

        bool getLocationInfo() const;

        void setReconnectionDelay(int reconnectionDelay1);

        int getReconnectionDelay() const;
 
#if LOG4CXX_ABI_VERSION <= 15
        void fireConnector();
#else
        void setSocketSubclass(const LogString& newSubclass);

        const LogString& getSocketSubclass() const;
#endif

        void setOption(const LogString& option, const LogString& value) override;
 
    protected:
        SocketAppenderSkeleton(std::unique_ptr<SocketAppenderSkeletonPriv> priv);
 
#if LOG4CXX_ABI_VERSION <= 15
        virtual void setSocket(helpers::SocketPtr& socket, helpers::Pool& p) = 0;

        virtual void cleanUp(LOG4CXX_NS::helpers::Pool& p) = 0;
#endif
        virtual int getDefaultDelay() const = 0;
 
        virtual int getDefaultPort() const = 0;
 
    private:
 
        SocketAppenderSkeleton(const SocketAppenderSkeleton&);
        SocketAppenderSkeleton& operator=(const SocketAppenderSkeleton&);
 
}; // class SocketAppenderSkeleton
} // namespace net
} // namespace log4cxx
 
#endif // _LOG4CXX_NET_SOCKET_APPENDER_SKELETON_H