github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/communication/request.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  // RequestEndpoint is special type that describes unique requests endpoint
    21  type RequestEndpoint string
    22  
    23  // RequestProducer represents instance which creates requests/responses of specific endpoint
    24  type RequestProducer interface {
    25  	// GetRequestEndpoint returns endpoint where to send requests
    26  	GetRequestEndpoint() (RequestEndpoint, error)
    27  	// Produce creates request which will be serialized to endpoint
    28  	Produce() (requestPtr interface{})
    29  	// NewResponse creates struct where responses from endpoint will be serialized
    30  	NewResponse() (responsePtr interface{})
    31  }
    32  
    33  // RequestConsumer represents instance which handles requests/responses of specific endpoint
    34  type RequestConsumer interface {
    35  	// GetRequestEndpoint returns endpoint where to receive requests
    36  	GetRequestEndpoint() (RequestEndpoint, error)
    37  	// NewRequest creates struct where request from endpoint will be serialized
    38  	NewRequest() (requestPtr interface{})
    39  	// Consume handles requests from endpoint and replies with response
    40  	Consume(requestPtr interface{}) (responsePtr interface{}, err error)
    41  }