UDP通信にてボタン押下で文字列を切り替えながら連続で出力する方法

Question

前提・実現したいこと

Android Studioを使用して、AndroidからPCへ以下の条件に沿った出力値をUDP通信で連続して出力するシステムを作成したいです。
・Button1が1度押下された場合、「A」が出力され、この値は0.1秒間保持される
・Button2が1度押下された場合、「B」が出力され、この値は0.1秒間保持される
・Button3が1度押下された場合、「C」が出力され、この値は0.1秒間保持される
・Buttonが押下されていない場合、「1」が出力され続ける

現状のプログラムとして
・アプリケーションが起動したときに、「1」が出力
・Button1が1度押下された場合、「A」が出力
・Button2が1度押下された場合、「B」が出力
・Button3が1度押下された場合、「C」が出力
までUDP通信で出力値を送信することができましたが、連続で出力する方法や出力値を保持する方法が分からず困っております。

※出力値はUdpIpToolで見ています。

該当のソースコード

MainActivity

public class MainActivity extends AppCompatActivity {

    private static int PORT = 34567; //ポート宣言
    DatagramSocket soc; //ソケット
    PrintWriter printWriter; //ソケット送信用
    String text;
    int a = 1;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        //サーバー用にソケットを作成し、ポートを設定する
        try {
            soc = new DatagramSocket(34567);
            soc.bind(new InetSocketAddress(PORT));
        } catch (Exception e) {
            e.printStackTrace();
        }


        //接続されたら"1"を出力
        SendSocTask sendSocTask = new SendSocTask(10);
        sendSocTask.execute();
        text ="1";

        Button button1 = findViewById(R.id.button1);
        button1.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                SendSocTask sendSocTask = new SendSocTask(1);
                sendSocTask.execute();
                text ="A";
            }
        });

        Button button2 = findViewById(R.id.button2);
        button2.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                SendSocTask sendSocTask = new SendSocTask(2);
                sendSocTask.execute();
                text ="B";
            }
        });

        Button button3 = findViewById(R.id.button3);
        button3.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                SendSocTask sendSocTask = new SendSocTask(3);
                sendSocTask.execute();
                text ="C";
            }
        });
    }

    class SendSocTask extends AsyncTask<InetSocketAddress, Void, Void> {

        private int sendValue;

        //コンストラクタ
        public SendSocTask(int value) { sendValue = value; }

        @Override
        protected Void doInBackground(InetSocketAddress... inetSocketAddresses) {
            try {
                byte[] ms = text.getBytes();
                DatagramPacket packet = new DatagramPacket(ms, ms.length, new InetSocketAddress(InetAddress.getByName("PCのIPアドレス"),PORT));
                    soc.send(packet);
            }
            catch (Exception e) {
            }
            finally {
                try {
                    //通信後、Socket接続を閉じ、関連付けられたすべてのリソース解放
                    if (a == 0) {
                        printWriter.close();
                    }
                    if (a==0) {
                    }
                }
                catch (Exception e) {
                    e.printStackTrace();
                }
            }
            return null;
        }
    }
}

activity_main

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">


    <Button
        android:id="@+id/button1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginEnd="10dp"
        android:text="Button"
        app:layout_constraintBaseline_toBaselineOf="@+id/button2"
        app:layout_constraintEnd_toStartOf="@+id/button2"
        app:layout_constraintStart_toStartOf="parent" />

    <Button
        android:id="@+id/button2"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginEnd="10dp"
        android:layout_marginBottom="324dp"
        android:text="Button"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toStartOf="@+id/button3"
        app:layout_constraintStart_toEndOf="@+id/button1" />

    <Button
        android:id="@+id/button3"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginEnd="1dp"
        android:text="Button"
        app:layout_constraintBaseline_toBaselineOf="@+id/button2"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toEndOf="@+id/button2" />
</androidx.constraintlayout.widget.ConstraintLayout>

試したこと

soc.send(packet);やclass SendSocTask内のコードにwhile(true)を挟み込み、無理に無限ループで出力してみましたが、
タブレットの画面は真っ白になり（正常に表示される場合もありました）、UdpIpToolのログも当たり前ですが「1」だけ出力され、「切断」をクリックしても無限ループし続けていました。

補足情報（FW/ツールのバージョンなど）

上記にも記載しましたが、Android studioを使用し、javaで作成しています。
どうにか実現したい事ができないかインターネットで調べてみましたが、
まったく実現方法がわかりませんでした…
お手数をおかけしますが、プログラミングの力も未熟なため丁寧に説明もいただけると大変ありがたいです。
何か不明点あれば、ご質問いただけますと幸いです。
よろしくお願いします。

Comments

[y_waiwai]

連続で出力するとは？どうなればいいんでしょう

[dodox86]

0.1秒間保持、と言うのが謎です。送信はワンショット、1回送ったら終わりです。

[jimbe]

> 無限ループで出力してみましたが、タブレットの画面は真っ白
android はシングルタスクですから、単純に無限ループすれば表示も操作も一切動作しなくなるのは "当然" です。

> どうにか実現したい事ができないかインターネットで調べてみました
どのような調査をされたのでしょうか。

[roatt]

>連続で出力するとは？どうなればいいんでしょう
>0.1秒間保持、と言うのが謎です。送信はワンショット、1回送ったら終わりです。

連続で送信されるといったほうが正しいかもしれません。
何もボタンを押さなければ
ずっと「1 1 1 1 1 1……」と送信され、
Button1が押されれば0.1秒間「A A A A ……」と送信されるようなイメージです。
その後何もボタンが押されなければまた「1 1 1 1……」と送信されますし、Button2が押されれば0.1秒間「B B B B……」文字列が送信されるプログラムを作りたいです。

[jimbe]

> android はシングルタスクですから、単純に無限ループすれば
すいません、 AsyncTask の doInBackground 内であれば関係無いですね。
失礼しました。

[roatt]

>すいません、 AsyncTask の doInBackground 内であれば関係無いですね。
>失礼しました。
いえいえ、いろいろ教えていただき感謝しています。

>どのような調査をされたのでしょうか。
連続で送信される方法を探したのですが、文字列を1度送信する方法しか見つけられませんでした。
指定時間分処理を行うプログラムも探しました。
Timer関数を使うものは発見しましたがいまいち理解できずやりたいことと同じことができるのかわからずこちらに質問をさせていただいた次第です。

Answer 1

絶え間なく送り続けるのも怖いので、 10ms 毎に送るものにしてみました。
と言っても IP はホストPCを指定しているものの、受信側を作るのが面倒だったので ( コメントにしてある )Log のみで確認しています。

package com.teratail.q374315;

import androidx.appcompat.app.AppCompatActivity;

import android.os.*;
import android.util.Log;
import android.widget.Button;

import java.io.IOException;
import java.net.*;
import java.util.*;

public class MainActivity extends AppCompatActivity {
  private static final String HOSTNAME = "10.0.2.2"; //エミュレータ→ホストPC
  private static final int PORT = 34567; //ポート宣言
  private static final String[] DATAS = {"1","A","B","C"};

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    try {
      DatagramTimerTask timerTask = new DatagramTimerTask(InetAddress.getByName(HOSTNAME), PORT, DATAS);

      Button button1 = findViewById(R.id.button1);
      button1.setOnClickListener(view -> timerTask.changePacket(1));

      Button button2 = findViewById(R.id.button2);
      button2.setOnClickListener(view -> timerTask.changePacket(2));

      Button button3 = findViewById(R.id.button3);
      button3.setOnClickListener(view -> timerTask.changePacket(3));

      Timer timer = new Timer();
      timer.scheduleAtFixedRate(timerTask, 0, 10); //[ms]

    } catch(SocketException e) {
      e.printStackTrace();
    } catch(UnknownHostException e) {
      e.printStackTrace();
    }
  }
}

class DatagramTimerTask extends TimerTask {
  private DatagramSocket soc;
  private DatagramPacket[] packets;
  private int packetIndex;
  private int count;

  DatagramTimerTask(InetAddress host, int port, String[] datas) throws SocketException {
    soc = new DatagramSocket(); //送るだけなら bind は不要

    packets = new DatagramPacket[datas.length];
    for(int i=0; i<datas.length; i++) {
      byte[] buf = datas[i].getBytes();
      packets[i] = new DatagramPacket(buf, buf.length, host, port);
    }
  }

  @Override
  public void run() {
    if(soc == null) return;
    try {
      synchronized(this) {
        soc.send(packets[packetIndex]);
        //Log.d("DatagramTimerTask","Datagram send index="+packetIndex);
        if(count>0 && --count==0) packetIndex = 0;
      }
    } catch(IOException e) {
      e.printStackTrace();
      soc.close();
      soc = null;
    }
  }

  public void changePacket(int packetIndex) {
    if(packetIndex < 0 || packetIndex >= packets.length) throw new IllegalArgumentException();
    synchronized(this) {
      this.packetIndex = packetIndex;
      this.count = 10; //10ms 毎に 10 回実行されれば 0.1 秒
    }
  }
}

Comments

[roatt]

返信が遅れ、申し訳ございません。
コードまでいただきありがとうございます。
一度試し、不明な関数は一度調べて理解を深めたいと思います。
その際、調べても理解できないところがありましたら質問させてください…
（自分なりに理解できたところでベストアンサーさせていただければ幸いです。）

[roatt]

jimbe様
いただいたコードで実行したところ、まさに私が実装したかったものになっておりました。
本当にありがとうございます。

知らないコードを調べ、確認したいところ、わからないところがあったため、以下の質問にお答えいただければ幸いです。

・このプログラムの流れとしては、
　①DatagramTimerTaskクラスでソケットの構築とpackets[i]に各文字コードをbyte型に変換したものを格納しておく
　②public void run()内のものをtimer.scheduleAtFixedRateで10ms単位で繰り返す
　※各ボタン押下時、changePacketが呼び出され、packetIndexの数値が変更され、serverSocket.send(packets[packetIndex]);で該当の文字コードが送信される。
　というようなイメージで合っておりますでしょうか？

・packets = new DatagramPacket[datas.length];が何を行っているのかをご教示いただきたいです。
　文字コードの文字数文の配列と読み解き、文字数もすべて1文字のため、数値に置き換えるとpackets = new DatagramPacket[1];なのかなと考えましたが、イマイチ腑に落ちておりません。

・ソケットのクローズ後、serverSocket = null;にするのはなぜでしょうか？

・if(packetIndex < 0 || packetIndex >= packets.length) throw new IllegalArgumentException();が何を意味しているのかわかりませんでした。
　IllegalArgumentExceptionが「メソッドに違法または不適切な引数が渡されたことを示す」とありますが、よくわかりません…
　packetIndexは「0，1，2，3」なので、マイナスになることもないかと思われますが、まかり間違ってマイナスが出てしまった際の例外処理というものなのでしょうか？
　また、packetIndex >= packets.lengthの条件もなぜついているのか理由をお聞きしたいです。

たくさん質問をして、申し訳ありません。
お手数ですが、よろしくお願いいたします。

[jimbe]

> ①DatagramTimerTaskクラスでソケットの構築とpackets[i]に各文字コードをbyte型に変換したものを格納しておく

この後で引用されています通り、該当行は
> packets = new DatagramPacket[datas.length];
であり、 packets の宣言は
> private DatagramPacket[] packets;
ですので、packets 配列の各要素は「各文字コードをbyte型に変換したもの」ではありません。
送信するデータグラムパケットそのものです。

> 数値に置き換えるとpackets = new DatagramPacket[1];なのかなと

datas は DatagramTimerTask のコンストラクトパラメータで、 その元は
> private static final String[] DATAS = {"1","A","B","C"};
です。ですから new DatagramPacket[datas.length] は new DatagramPacket[4] ということになります。
「packets 配列は 4 つの DatagramPacket オブジェクトを保持する領域を持つ」ということです。

> serverSocket = null;

そのような行はありません。run() 内の 例外発生時の soc = null のことでしょうか。
回答のコードは基本的には参考ですので、ソケットの後始末まではキチンとはしていません。
タイマーの停止もしていませんので、もし送信で何か異常が発生した場合でも延々と送信をしようとし、延々と例外が発生することになります。
異常が起きた場合はログに例外のメッセージを出力しますが、延々と(恐らくは同じ)例外のメッセージが残っていても意味がありませんので、例外発生時は一応 close した上で soc を null とし、 run() の先頭で null だったら送信を行わないことで、メッセージが延々とログに残るのを防いでいます。
この辺りの処理内容につきましては、「送信で異常が起きたらどうするか」という設計によって異なります。
「何か画面に表示して、通信が出来るようになるまでタイマーを停止する」とかであれば、そのようなコードを加える必要があるでしょう。

> if(packetIndex < 0 || packetIndex >= packets.length) throw new IllegalArgumentException();が何を意味しているのか

単なるパラメータチェックです。
「参考コードなら別に無くても」良いんですが、このコードでは packetIndex の値は changePacket() 内では無く run() 内で使用しています。「値を受け取る個所」と「実際に使う個所」が動作タイミングとして離れていると分かり難いですので、受け取る個所の changePacket() で早々にエラーとしています。
> packetIndexは「0，1，2，3」なので
と仰られる通り「 packetIndex が 0 未満か 4 以上ならパラメータエラー(例外)」という文です。

[jimbe]

システムを構成するプログラムは、正常動作時の処理だけではありません。
今はどうなのか知りませんが、以前チラと見聞きした話では、システムを構成するプログラムの 7~80% は異常が起きた時に対処する処理だそうです。
数値の真偽はともかく、プログラムが動作する環境は常に変わり、それに対してどこまで堅牢に動作し続けることが出来るかが、プログラムの質の評価に関わります。
それはユーザが業務に使う場合に限らず、自分以外のプログラマ(時には"明日の自分")が開発に使う場合も含まれます。
パラメータが範囲内にある必要があり、範囲外を指定したら何が起きるのか、通信できていたものが突然できなくなったら何が起きるのか、そしてそれぞれ何をするべきなのかは、常に考える必要があります。(考えた結果「何もしない」という判断ももちろんあり得ます。)

[roatt]

なるほど、非常にわかりやすい説明をありがとうございます。
※おっしゃる通りsoc = nullのことを質問したかったのですが、別のプログラムのものを引用してしまいました…
　申し訳ありません。

追加で質問なのですが、いただいたコードのところにコメントで「送るだけならbindは不要」とはどのような意味でしょうか？
UdpIpToolにて受信側を見たところ、接続切断はポート番号（34567）で文字コードの送信は別の番号（そのときに接続できる番号？）でした。
何度か接続切断を繰り返したときに、一瞬だけ別のポート番号で受信され、例えばbutton1を押した場合、「AAA11A1AAA」みたいな感じで受信されていることがあります。
それを阻止するために、ポート番号の送信側のbindが必要なのではないかと考えたのですが、いかがでしょうか？
（安易に
「soc = new DatagramSocket(34567);
　soc.bind(new InetSocketAddress(PORT));
」
と入れてみましたが、当たり前ですが、うまく送受信はできませんでした。
設定したポートで送受信を行うとした場合、jimbe様がおっしゃっていた「面倒な受信側の作成」を行わなければならないのでしょうか？）

[jimbe]

IP 通信はアドレスとポート番号の組で行われます。
UDP にせよ TCP にせよ、受信側は特定のアドレス・ポートで受信待ちをし、送信側はそこに送ります。
ですから、受信側はポートのバインド(してそのポートを送信側に予め伝えておくこと)が必要ですが、送信側はどのポートを使っても問題ありません。DatagramSocket はポート番号が指定されないと、テキトウに空いているポートを使います。
現実の手紙で言えば、受け取り側の居る住所さえ分かっていれば、送る側は何処にいても(投函さえ出来れば)送れるのと同じことです。

受信側で受信するパケットの順が送信側が送信した順と異なることがあるのは UDP の仕様です。
順番に届くこと(もしくは順番に届いたように見せること)が必要な場合は、そのようなプロトコルを作成する必要があります。
UDP が何を保証して何を保証していないかは、 UDP の仕様を御覧ください。

[jimbe]

私がテストの為に受信側を作るのを面倒としましたのは、送信側が Android で 受信側が PC ですと、 AndroidStudio と Eclipse を同時に動かしてそれぞれにコードを入力してエミュレータも動かして(他に資料を探すブラウザやら BGM 的な YouTube やらゲームやら)…とディスプレイ内がごちゃごちゃして切り替えながら動かすのが「面倒」だったのです ^^;;;

[jimbe]

念を押すようですが、回答のコードで送信に使う DatagramSocket に指定するのは、「受信側がどのポートで待っているか」では無く、送信にどのポートを使うか、です。
「受信側がどのポートで待っているか」は DatagramPacket のコンストラクタで ( アドレスと共に ) 指定しており、プロトコル上は両者のポート番号に関係はありません。

[roatt]

繰り返しになってしまうかもしれませんが、今回のコードに置き換えると
送信側はDatagramSocketでポートを指定せず、そのとき空いているポートから文字コードを送信していて、
受信側はnew DatagramPacket(buf, buf.length, host, port);でhostとportから受信側の住所（今回で言うHOSTNAME = "10.0.2.2"とPORT = 34567）を指定している
という理解であっていますか？

[jimbe]

UDP の送受信の単位は"文字コード"では無く"UDPパケット"です。
その"UDPパケット"を java の オブジェクトとして表したものが DatagramPacket オブジェクト、そのパケットを送受信する機能を有するのが DatagramSocket オブジェクトです。
仰る言葉を置き換えれば、
「送信は (DatagramSocket でポートを指定しないことで ) そのとき空いているポートからパケットを送信していて、その時の送り先(受信側)は new DatagramPacket(buf, buf.length, host, port) の host と port ( 今回で言う HOSTNAME="10.0.2.2" と PORT=34567) で指定している」
という感じでしょうか。
buf( と buf.length) がパケットの中身=手紙の本文ですから、new DatagramPacket(buf, buf.length, host, port) で「ハガキの表の住所宛名と裏の本文全てを書き込んだ」ようなパケットの生成となっています。

[roatt]

非常にわかりやすい説明をありがとうございました。
納得しました！
私のつたない質問に根気よく説明いただき本当に感謝しております。
いつもありがとうございます。