plc4net/api/messages/IPlcUnsubscriptionRequestBuilder.cs

/*
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.
*/

using System.Collections.Generic;
using org.apache.plc4net.model;

namespace org.apache.plc4net.messages
{
    /// <summary>
    /// Constructs requests for unsubscribing from PLC fields
    /// </summary>
    public interface IPlcUnsubscriptionRequestBuilder: 
        IPlcRequestBuilder<IPlcUnsubscriptionRequest>
    {
        /// <summary>
        /// Add the given handles to the unsubscription request
        /// </summary>      
        /// <param name="subscriptionHandles">Handles to unsubscribe</param>
        /// <returns>Builder for chaining requests as Fluid API</returns>
        IPlcUnsubscriptionRequestBuilder AddHandles(params IPlcSubscriptionHandle[] subscriptionHandles);

        /// <summary>
        /// Add the given handles to the unsubscription request
        /// </summary>      
        /// <param name="subscriptionHandles">Handles to unsubscribe</param>
        /// <returns>Builder for chaining requests as Fluid API</returns>
        IPlcUnsubscriptionRequestBuilder AddHandles(IEnumerable<IPlcSubscriptionHandle> subscriptionHandles);
    }
}