org.apache.tuweni.scuttlebutt.lib.ScuttlebuttClient Maven / Gradle / Ivy

Go to download
/*
 * 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.
 */
package org.apache.tuweni.scuttlebutt.lib;

import org.apache.tuweni.scuttlebutt.rpc.mux.Multiplexer;


/**
 * A client for making requests to a scuttlebutt instance with. This is the entry point for accessing service classes
 * which perform operations related to different logical areas.
 *
 * Should be constructed using the ScuttlebuttClientFactory factory class.
 *
 */
public class ScuttlebuttClient {

  private final Multiplexer multiplexer;

  private final FeedService feedService;

  /**
   *
   * @param multiplexer the multiplexer to make RPC requests with.
   */
  protected ScuttlebuttClient(Multiplexer multiplexer) {
    this.multiplexer = multiplexer;
    this.feedService = new FeedService(multiplexer);
  }

  /**
   * Provides a service for operations that connect nodes together.
   *
   * @return a service for operations that connect nodes together
   */
  public NetworkService getNetworkService() {
    return new NetworkService(multiplexer);
  }

  /**
   * Provides a service for operations that concern scuttlebutt feeds.
   *
   * @return a service for operations that concern scuttlebutt feeds
   */
  public FeedService getFeedService() {
    return feedService;
  }

  /**
   * Provides a service for operations concerning social connections and updating the instance's profile
   *
   * @return a service for operations concerning social connections and updating the instance's profile
   */
  public SocialService getSocialService() {
    return new SocialService(multiplexer, feedService);
  }


  /**
   * Provides a service for making lower level requests that are not supported by higher level services.
   *
   * @return a service for making lower level requests that are not supported by higher level services
   */
  public RawRequestService rawRequestService() {
    return new RawRequestService(multiplexer);
  }

}