001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import org.jspecify.annotations.NonNull;
020
021/**
022 * Represents an operation performed with a callback-scoped {@link NotificationSession}.
023 * <p>
024 * Pyranid invokes the operation synchronously, at most once, after all requested notification channels have been
025 * registered. The session is valid only while {@link #perform(NotificationSession)} is active and must not be retained
026 * or used from another thread.
027 *
028 * @author <a href="https://www.revetkn.com">Mark Allen</a>
029 * @since 4.6.0
030 */
031@FunctionalInterface
032public interface NotificationSessionOperation {
033        /**
034         * Performs work with the provided notification session.
035         *
036         * @param session callback-scoped notification session
037         * @throws Exception if the operation fails
038         * @since 4.6.0
039         */
040        void perform(@NonNull NotificationSession session) throws Exception;
041}