All Downloads are FREE. Search and download functionalities are using the official Maven repository.

dorkbox.messageBus.subscription.reflection.SubscriptionReflectionWeak Maven / Gradle / Ivy

Go to download 

/*
 * Copyright 2012 Benjamin Diedrichsen
 *
 * Permission is hereby granted, free  of charge, to any person obtaining
 * a  copy  of this  software  and  associated  documentation files  (the
 * "Software"), to  deal in  the Software without  restriction, including
 * without limitation  the rights to  use, copy, modify,  merge, publish,
 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
 * permit persons to whom the Software  is furnished to do so, subject to
 * the following conditions:
 *
 * The  above  copyright  notice  and  this permission  notice  shall  be
 * included in all copies or substantial portions of the Software.
 *
 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 *
 * Copyright 2015 dorkbox, llc
 *
 * 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 dorkbox.messageBus.subscription.reflection;

import java.lang.ref.WeakReference;
import java.lang.reflect.Method;

import dorkbox.messageBus.common.MessageHandler;
import dorkbox.messageBus.error.ErrorHandler;
import dorkbox.messageBus.error.PublicationError;
import dorkbox.messageBus.subscription.Entry;
import dorkbox.messageBus.publication.Publisher;
import dorkbox.messageBus.subscription.Subscription;

/**
 * A subscription is a container that manages exactly one message handler of all registered
 * message listeners of the same class, i.e. all subscribed instances (excluding subclasses) of a message
 * will be referenced in the subscription created for a message.
 * 

 * There will be as many unique subscription objects per message listener class as there are message handlers
 * defined in the message listeners class hierarchy.
 * 

 * This class uses the "single writer principle", so that the subscription are only MODIFIED by a single thread,
 * but are READ by X number of threads (in a safe way). This uses object thread visibility/publication to work.
 *
 * @author bennidi
 * @author dorkbox, llc
 *         Date: 2/2/15
 */
@SuppressWarnings("Duplicates")
final
class SubscriptionReflectionWeak extends Subscription> {
    private final Object singleWriterLock = new Object();

    private final Method method;
    private final ReflectionInvocation invocation;

    public
    SubscriptionReflectionWeak(final Class listenerClass, final MessageHandler handler) {
        // we use "normal java" here
        super(listenerClass, handler);

        ReflectionInvocation invocation = new ReflectionReflectiveInvocation();
        if (handler.isSynchronized()) {
            invocation = new ReflectionSynchronizedInvocation(invocation);
        }

        this.invocation = invocation;
        method = handler.getMethod();
    }

    @Override
    public
    Entry> createEntry(final Object listener, final Entry head) {
        return new Entry>(new WeakReference(listener), head);
    }

    @Override
    public
    void subscribe(final Object listener) {
        // extra locking to ensure the single-writer-principle (with regards to how cleaning up orphans works)
        synchronized (singleWriterLock) {
            super.subscribe(listener);
        }
    }

    @Override
    public
    void unsubscribe(final Object listener) {
        // extra locking to ensure the single-writer-principle (with regards to how cleaning up orphans works)
        synchronized (singleWriterLock) {
            super.unsubscribe(listener);
        }
    }

    @Override
    public
    boolean publish(final Publisher publisher, final ErrorHandler errorHandler,
                    final Object message) {

        final Method method = this.method;
        final ReflectionInvocation invocation = this.invocation;

        Entry> head = cast(headREF.get(this));
        Entry> current = head;
        Object listener;
        while (current != null) {
            listener = current.getValue().get();
            if (listener == null) {
                Entry> next = current.next();

                synchronized (singleWriterLock) {
                    removeNode(current); // this means it has been garbage collected!! we need to clean up ourselves
                }
                current = next;
                continue;
            }
            current = current.next();

            try {
                invocation.invoke(listener, method, message);
            } catch (Throwable e) {
                errorHandler.handlePublicationError(new PublicationError().setMessage("Error during publication of message.")
                                                                          .setCause(e)
                                                                          .setPublishedObject(message));
            }
        }

        // because the value can be GC'd at any time, this is the best guess possible
        return head != null && head.getValue() != null;  // true if we have something to publish to, otherwise false
    }

    @Override
    public
    boolean publish(final Publisher publisher, final ErrorHandler errorHandler,
                    final Object message1, final Object message2) {

        final Method method = this.method;
        final ReflectionInvocation invocation = this.invocation;

        Entry> head = cast(headREF.get(this));
        Entry> current = head;
        Object listener;
        while (current != null) {
            listener = current.getValue().get();
            if (listener == null) {
                Entry> next = current.next();

                synchronized (singleWriterLock) {
                    removeNode(current); // this means it has been garbage collected!! we need to clean up ourselves
                }
                current = next;
                continue;
            }
            current = current.next();

            try {
                invocation.invoke(listener, method, message1, message2);
            } catch (Throwable e) {
                errorHandler.handlePublicationError(new PublicationError().setMessage("Error during publication of message.")
                                                                          .setCause(e)
                                                                          .setPublishedObject(message1, message2));
            }
        }

        // because the value can be GC'd at any time, this is the best guess possible
        return head != null && head.getValue() != null;  // true if we have something to publish to, otherwise false
    }

    @Override
    public
    boolean publish(final Publisher publisher, final ErrorHandler errorHandler,
                    final Object message1, final Object message2, final Object message3) {

        final Method method = this.method;
        final ReflectionInvocation invocation = this.invocation;

        Entry> head = cast(headREF.get(this));
        Entry> current = head;
        Object listener;
        while (current != null) {
            listener = current.getValue().get();
            if (listener == null) {
                Entry> next = current.next();

                synchronized (singleWriterLock) {
                    removeNode(current); // this means it has been garbage collected!! we need to clean up ourselves
                }
                current = next;
                continue;
            }
            current = current.next();

            try {
                invocation.invoke(listener, method, message1, message2, message3);
            } catch (Throwable e) {
                errorHandler.handlePublicationError(new PublicationError().setMessage("Error during publication of message.")
                                                                          .setCause(e)
                                                                          .setPublishedObject(message1, message2, message3));
            }
        }

        // because the value can be GC'd at any time, this is the best guess possible
        return head != null && head.getValue() != null;  // true if we have something to publish to, otherwise false
    }

    @SuppressWarnings("unchecked")
    private static
     T cast(Object obj) {
        return (T) obj;
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy