github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/communication/message.go (about)

     1  /*
     2   * Copyright (C) 2017 The "MysteriumNetwork/node" Authors.
     3   *
     4   * This program is free software: you can redistribute it and/or modify
     5   * it under the terms of the GNU General Public License as published by
     6   * the Free Software Foundation, either version 3 of the License, or
     7   * (at your option) any later version.
     8   *
     9   * This program is distributed in the hope that it will be useful,
    10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12   * GNU General Public License for more details.
    13   *
    14   * You should have received a copy of the GNU General Public License
    15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    16   */
    17  
    18  package communication
    19  
    20  // MessageEndpoint is special type that describes unique message endpoint
    21  type MessageEndpoint string
    22  
    23  // MessageProducer represents instance which creates messages to specific endpoint
    24  type MessageProducer interface {
    25  	// GetMessageEndpoint returns endpoint where to send messages
    26  	GetMessageEndpoint() (MessageEndpoint, error)
    27  	// Produce creates message which will be serialized to endpoint
    28  	Produce() (messagePtr interface{})
    29  }
    30  
    31  // MessageConsumer represents instance which handles messages of specific endpoint
    32  type MessageConsumer interface {
    33  	// GetMessageEndpoint returns endpoint where to receive messages
    34  	GetMessageEndpoint() (MessageEndpoint, error)
    35  	// NewMessage creates struct where message from endpoint will be serialized
    36  	NewMessage() (messagePtr interface{})
    37  	// Consume handles messages from endpoint
    38  	Consume(messagePtr interface{}) error
    39  }