uk.co.real_logic.aeron.driver.event.EventConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aeron-driver Show documentation
Efficient reliable UDP unicast, UDP multicast, and IPC transport protocol.
There is a newer version: 0.9.4
/*
 * Copyright 2014 - 2015 Real Logic Ltd.
 *
 * 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.
 */
package uk.co.real_logic.aeron.driver.event;

import uk.co.real_logic.agrona.concurrent.ringbuffer.RingBufferDescriptor;

import java.util.EnumSet;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

/**
 * Common configuration elements between event loggers and event reader side
 */
public class EventConfiguration
{
    /**
     * Event Buffer length system property name
     */
    public static final String BUFFER_LENGTH_PROPERTY_NAME = "aeron.event.buffer.length";

    /**
     * Event tags system property name. This is either:
     * 
     * A comma separated list of EventCodes to enable
     * "all" which enables all the codes
     * "prod" which enables the codes specified by PRODUCTION_LOGGER_EVENT_CODES
     * 
     */
    public static final String ENABLED_LOGGER_EVENT_CODES_PROPERTY_NAME = "aeron.event.log";

    public static final Set PRODUCTION_LOGGER_EVENT_CODES = EnumSet.of(
        EventCode.EXCEPTION,
        EventCode.MALFORMED_FRAME_LENGTH,
        EventCode.ERROR_DELETING_FILE);

    public static final Set ADMIN_ONLY_EVENT_CODES = EnumSet.of(
        EventCode.EXCEPTION,
        EventCode.MALFORMED_FRAME_LENGTH,
        EventCode.CMD_IN_ADD_PUBLICATION,
        EventCode.CMD_IN_ADD_SUBSCRIPTION,
        EventCode.CMD_IN_KEEPALIVE_CLIENT,
        EventCode.CMD_IN_REMOVE_PUBLICATION,
        EventCode.CMD_IN_REMOVE_SUBSCRIPTION,
        EventCode.REMOVE_IMAGE_CLEANUP,
        EventCode.REMOVE_PUBLICATION_CLEANUP,
        EventCode.REMOVE_SUBSCRIPTION_CLEANUP,
        EventCode.CMD_OUT_PUBLICATION_READY,
        EventCode.CMD_OUT_AVAILABLE_IMAGE,
        EventCode.CMD_OUT_ON_UNAVAILABLE_IMAGE,
        EventCode.CMD_OUT_ON_OPERATION_SUCCESS,
        EventCode.ERROR_DELETING_FILE,
        EventCode.CHANNEL_CREATION);

    public static final Set ALL_LOGGER_EVENT_CODES = EnumSet.allOf(EventCode.class);

    /**
     * Event Buffer default length (in bytes)
     */
    public static final int BUFFER_LENGTH_DEFAULT = 65536;

    /**
     * Maximum length of an event in bytes
     */
    public static final int MAX_EVENT_LENGTH = 2048;

    /**
     * Limit for event reader loop
     */
    public static final int EVENT_READER_FRAME_LIMIT = 10;

    private static final Pattern COMMA = Pattern.compile(",");

    public static long getEnabledEventCodes()
    {
        return makeTagBitSet(getEnabledEventCodes(System.getProperty(ENABLED_LOGGER_EVENT_CODES_PROPERTY_NAME)));
    }

    public static int bufferLength()
    {
        return Integer.getInteger(
            EventConfiguration.BUFFER_LENGTH_PROPERTY_NAME,
            EventConfiguration.BUFFER_LENGTH_DEFAULT) + RingBufferDescriptor.TRAILER_LENGTH;
    }

    static long makeTagBitSet(final Set eventCodes)
    {
        return
            eventCodes
                .stream()
                .mapToLong(EventCode::tagBit)
                .reduce(0L, (acc, x) -> acc | x);
    }

    /**
     * Get the {@link Set} of {@link EventCode}s that are enabled for the logger.
     *
     * @param enabledLoggerEventCodes that can be "all", "prod" or a comma separated list.
     * @return the {@link Set} of {@link EventCode}s that are enabled for the logger.
     */
    static Set getEnabledEventCodes(final String enabledLoggerEventCodes)
    {
        if (enabledLoggerEventCodes == null)
        {
            return PRODUCTION_LOGGER_EVENT_CODES;
        }

        switch (enabledLoggerEventCodes)
        {
            case "all":
                return ALL_LOGGER_EVENT_CODES;

            case "prod":
                return PRODUCTION_LOGGER_EVENT_CODES;

            case "admin":
                return ADMIN_ONLY_EVENT_CODES;

            default:
                return COMMA
                    .splitAsStream(enabledLoggerEventCodes)
                    .map(EventCode::valueOf)
                    .collect(Collectors.toSet());
        }
    }
}