...

Source file src/solace.dev/go/messaging/pkg/solace/message/rgmid/replication_group_message_id.go

Documentation: solace.dev/go/messaging/pkg/solace/message/rgmid

     1  // pubsubplus-go-client
     2  //
     3  // Copyright 2021-2024 Solace Corporation. All rights reserved.
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  // http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  // Package rgmid contains the ReplicationGroupMessageID interface.
    18  package rgmid
    19  
    20  // ReplicationGroupMessageID represents a ReplicationGroupMessageID of a message.
    21  type ReplicationGroupMessageID interface {
    22  	// Compare compares the ReplicationGroupMessageID to another.
    23  	// Not all valid ReplicationGroupMessageID
    24  	// instances can be compared. If the messages identified were not published
    25  	// to the same broker or HA pair, then they are not comparable and a
    26  	// *solace.IllegalArgumentError is returned.
    27  	Compare(ReplicationGroupMessageID) (result int, err error)
    28  	// String returns the ReplicationGroupMessageID as a string value.
    29  	String() string
    30  }
    31