mocket

モケット

 Lightweight, Typesafe, Reliable, Guaranty delivery, Ordered, High performant java nio sockets build 
on top of udp.

ダウンロード

• リポジトリとして jitpack を使用する
• 依存関係にモケットを追加する

以下に示すように:

1. メイビン

< project >
...
    < repositories >
    ...
        < repository >
            < id >jitpack.io</ id >
            < url >https://jitpack.io</ url >
        </ repository >
    </ repositories >
</ project >

    < dependencies >
        ...
        < dependency >
            < groupId >com.github.Nishant-Pathak</ groupId >
            < artifactId >mocket</ artifactId >
            < version >v1.0</ version >
        </ dependency >
    </ dependencies >

2. グラドル

    allprojects {
        repositories {
            .. .
            maven { url ' https://jitpack.io ' }
        }
    }

    dependencies {
        compile ' com.github.Nishant-Pathak:mocket:v1.0 '
    }

シンプルサーバー

サーバーを構築するには:

   ServerBuilder < byte []> serverBuilder = new ServerBuilder < byte []>()
        . port ( serverPort );
   Server < byte []> server = serverBuilder . build ();

読むには:

    while ( true ) {
      // blocking read
      Pair < SocketAddress , byte []> readBytes = server . read ();
    }

書くには:

    // write to server
    server . write ( read . getSecond (), read . getFirst ());

署名を書きます:

  /**
   * writed data to the given address
   * @param data to send to addredd
   * @param address of the client connected
   * @throws IOException if error occurs while writing to the socket
   * @throws InterruptedException if write is interrupted
   */
  void write ( T data , SocketAddress address ) throws IOException , InterruptedException ;

シンプルクライアント

クライアントを構築するには:

    ClientBuilder < byte []> builder = new ClientBuilder < byte []>()
        . host ( "127.0.0.1" , 8080 );
    Client < byte []> client = builder . build ();

読むには:

    // blocking read
    byte [] data = client . read ();

書くには:

   client . write ( data );

署名を書きます:

  /**
   * write object of type T on the wire
   * it used @{@link com.network.mocket.handler.MocketStreamHandler} to parse the object
   * @param data object to send on wire to the server.
   * @throws IOException if error occurs while writing to the socket
   * @throws InterruptedException if write is interrupted
   */
  void write ( T data ) throws IOException , InterruptedException ;

カスタムマッパーを作成するには

Java インターフェイスを実装し、クライアントおよびサーバー ビルダーに次のように追加します。

        builder . addHandler ( new MyCustomHandler ())

 public interface MocketStreamHandler < P > {
  /**
   * Used to encode object to byte stream
   * @param in inout object of tye {P}
   * @return byte array representing object
   * @throws ParseException throws if fails to encode or decode
   */
  byte [] encode ( P in ) throws ParseException ;

  /**
   * Used to decode bytestream to object
   * @param out inout object of tye {P}
   * @return byte array representing object
   * @throws ParseException throws if fails to encode or decode
   */
  P decode ( byte [] out ) throws ParseException ;
}

例

サンプルサーバークライアントはここにあります。

Android アプリのデモ

使用事例

1. データセンター内のサービス間通信。
2. Android アプリで使用すると、不安定なネットワークでのパフォーマンスが向上します。
3. センサーベースの Android Things デバイスで使用して、定期的なデータをサーバーにプッシュ*します。

※ゲートウェイによってはUDPトラフィックをブロックする場合があります。

次のマイルストーン

1. SSL サポートを追加します。
2. TCP をサポートします。
3. マルチパート TCP サポート。

貢献する

フィードバック、バグレポート、さらにはプルリクエストの形で、プロジェクトへの外部からの貢献を喜んで受け入れます:)

プル リクエストを送信したい場合は、CONTRIBUTING.md のガイドに従ってください。

ライセンス

著作権 (C) 2016 - 2017 ニシャント・パタック

 Licensed 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.