com.blazebit.notify.channel.memory.MemoryChannel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of blaze-notify-channel-memory Show documentation
The newest version!
/*
 * Copyright 2018 - 2025 Blazebit.
 *
 * 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 com.blazebit.notify.channel.memory;

import com.blazebit.notify.Channel;
import com.blazebit.notify.ChannelKey;
import com.blazebit.notify.NotificationMessage;
import com.blazebit.notify.NotificationRecipient;

import java.util.Queue;
import java.util.concurrent.ArrayBlockingQueue;

/**
 * A in-memory channel that sends messages to a queue.
 *
 * @param  The notification recipient type
 * @param  The notification message type
 * @author Christian Beikov
 * @since 1.0.0
 */
public class MemoryChannel, T extends NotificationMessage> implements Channel {

    /**
     * The key for which the channel is registered.
     */
    public static final ChannelKey, NotificationMessage>> KEY = (ChannelKey, NotificationMessage>>) (ChannelKey) ChannelKey.of("memory", MemoryChannel.class);
    private static final int DEFAULT_CAPACITY = 1024;
    private final Queue queue;

    /**
     * Creates a channel with a queue that has a default capacity.
     */
    public MemoryChannel() {
        this(DEFAULT_CAPACITY);
    }

    /**
     * Creates a channel with a queue with the given capacity.
     *
     * @param capacity The capacity
     */
    public MemoryChannel(int capacity) {
        this(new ArrayBlockingQueue(capacity));
    }

    /**
     * Creates a channel with the given queue.
     *
     * @param queue The queue
     */
    public MemoryChannel(Queue queue) {
        this.queue = queue;
    }

    /**
     * Returns the queue.
     *
     * @return the queue
     */
    public Queue getQueue() {
        return queue;
    }

    @Override
    public Class getNotificationMessageType() {
        return (Class) NotificationMessage.class;
    }

    @Override
    public Object sendNotificationMessage(R recipient, T message) {
        queue.add(message);
        return null;
    }

    @Override
    public void close() {
    }
}