TcpConnection 類別 參考文件

實作 TCP 特定通訊並擴展 AComm 類別的類別。 更多...

類別TcpConnection的繼承圖:

複合項目
enum	DescriptorPortType
	用於請求具有預設埠值的描述符類型 更多...

公開方法(Public Methods)
	TcpConnection (String descriptor)
	根據 descriptor 字串初始化新類別實例。 更多...
	TcpConnection (String ipAddress, int port)
	Initialize new class instance.
int	BytesAvailable ()
	Number of bytes available to read. This is estimate and number can change as data is received.
void	Close ()
	Closes a connection.
boolean	Connected ()
	true if connection is established
String	Descriptor ()
	根據 descriptor 字串初始化新類別實例。 更多...
String	IpAddress ()
	IP address of connection.
void	Open ()
	Opens a connection.
int	Port ()
	Port Number of connection.
byte[]	Read ()
	Read all bytes available.
void	Read (OutputStream binDataIn) throws IOException
	Reads all bytes available into the stream passed in.
void	WaitForData (int msTimeOut)
	等待當前執行緒有可用的資料 BytesAvailable。當前執行緒會休眠直到收到資料或超時為止。此為阻塞呼叫。 更多...
void	Write (byte[] dataOut)
	Writes all bytes from the array passed in.
void	Write (InputStream binReader) throws IOException
	從輸入流寫入輸出流。 更多...
byte[]	WriteAndWaitForResponse (byte[] dataOut, int responseStartTimeOut, int responseEndTimeOut, String completetionToken) throws IOException
	將位元組資料寫入輸出流並返回接收到的資料。返回的資料是接收到的任何資料或收到的完成標記。等待回應超時後返回。 更多...
void	WriteAndWaitForResponse (OutputStream binDataIn, InputStream binDataOut, int responseStartTimeOut, int responseEndTimeOut, String completetionToken) throws IOException
	將 binDataOut 流資料寫入輸出流，並將接收到的資料返回到 binDataIn 流中。返回的資料是收到的資料或收到的完成標記。等待回應超時後返回。 更多...

靜態公開方法(Static Public Methods)
static String	DescriptorValidate (String descriptorHint, DescriptorPortType portTypeHint)
	從可能有或沒有端口的 descriptorHint 驗證/構建描述符字串。返回有效的描述符或空的 "" 字串。 更多...

靜態公開屬性
static final int	DEFAULT_DATA_PORT = 9100
	Port for sending print data.
static final int	DEFAULT_MGMT_PORT = 3007
	Port used to control and manage printers.
static final int	DEFAULT_STATUS_PORT = 3002
	Port for listening to status messages from printer. 更多...

詳細描述

實作 TCP 特定通訊並擴展 AComm 類別的類別。

範例

package com.test.UniPRTSdk;
 
import com.UniPRT.Sdk.Comm.TcpConnection;
import java.io.*;
 
public class commTcpSnippet {
    public static void main(String[] args) {
        String prtIp = "127.0.0.1";
        sendPrintFile(prtIp);     // send file over default printer data port
        sendPrintString(prtIp);   // send print data over default printer data port
    }
 
    public static void sendPrintFile(String ipAddress) {
        String fileName = "C:\\testFiles\\Hello.pgl";
        int defaultDataPort = TcpConnection.DEFAULT_DATA_PORT;
 
        TcpConnection ptrTcpComm = new TcpConnection(ipAddress, defaultDataPort); // sending through default data port
 
        try {
            ptrTcpComm.Open();
            if (new File(fileName).exists()) {
                try (InputStream binReader = new BufferedInputStream(new FileInputStream(fileName))) {
                    System.out.println("Sending \"" + fileName + "\" to printer");
 
                    byte[] buffer = new byte[1024];
                    while ((binReader.read(buffer)) != -1) {
                        ptrTcpComm.Write(buffer);
                    }
                }
            } else {
                System.out.println("File \"" + fileName + "\" not found");
            }
        } catch (Exception e) {
            System.out.println("Exception Msg: " + e.getMessage());
        } finally {
            ptrTcpComm.Close();
        }
    }
 
    public static void sendPrintString(String ipAddress) {
        String dataToPrint =
                "~CREATE;C39;72\n" +
                        "SCALE;DOT\n" +
                        "PAGE;30;40\n" +
                        "ALPHA\n" +
                        "C10;1;33;0;0;@HELLO@\n" +
                        "C16;54;37;0;0;@*World*@\n" +
                        "STOP\n" +
                        "BARCODE\n" +
                        "C128C;XRD3:3:6:6:9:9:12:12;H6;10;32\n" +
                        "@World@\n" +
                        "STOP\n" +
                        "END\n" +
                        "~EXECUTE;C39\n" +
                        "~NORMAL\n";
 
        int defaultDataPort = TcpConnection.DEFAULT_DATA_PORT;
 
        TcpConnection ptrTcpComm = new TcpConnection(ipAddress, defaultDataPort); // sending through default data port
 
        try {
            ptrTcpComm.Open();
            if (ptrTcpComm.Connected()) {
                byte[] outBytes = dataToPrint.getBytes("US-ASCII");
                ptrTcpComm.Write(outBytes);
            } else {
                System.out.println("Not connected to printer");
            }
        } catch (Exception e) {
            System.out.println("Exception Msg: " + e.getMessage());
        } finally {
            ptrTcpComm.Close();
        }
    }
}

建構子與解構子說明文件

TcpConnection()

TcpConnection

(

String

descriptor

)

根據 descriptor 字串初始化新類別實例。

參數

[in]

descriptor

用冒號（:）分隔的連線描述字串。 可接受的格式： <ip> IP 地址格式為 #.#.#.#。例如：127.0.0.1 使用預設數據端口 (DEFAULT_DATA_PORT) <ip>:<port> IP 地址和特定端口號格式為 #.#.#.#:#。例如：127.0.0.1:9100 <type>:<ip>:<port> IP 地址和特定端口號格式為 "TCP":#.#.#.#:#。例如：TCP:127.0.0.1:9100 請注意，無論傳遞的是什麼，連線的 type 總是 "TCP" <IPv6 位址>="">:<port> 使用中括號格式表示 IPv6，例如：[2001:db8::1]:9100 或 [fe80::1wlan0]:3007

函式成員說明文件

Descriptor()

String Descriptor

(

)

根據 descriptor 字串初始化新類別實例。

參數

[in]

descriptor

用冒號（:）分隔的連線描述字串。 可接受的格式： <ip> 僅 IPv4 位址，使用預設端口。 例如："192.168.1.193" <ip>:<port> IPv4 與指定端口。 例如："192.168.1.193:3007" TCP:<ip>:<port> 明確指定 TCP 與 IPv4 + 端口。 例如："TCP:192.168.1.193:3007" [<IPv6>] 僅 IPv6 位址（使用中括號），使用預設端口。 例如："[2001:b030:2219:c40:208:96ff:fe40:9b04]" [<IPv6>]:<port> IPv6 位址與指定端口。 例如："[2001:b030:2219:c40:208:96ff:fe40:9b04]:3007" TCP:[<IPv6>]:<port> 指定 TCP 前綴，IPv6 與端口。 例如："TCP:[2001:b030:2219:c40:208:96ff:fe40:9b04]:3007" [<Link-local IPv6>%<interface>] 含 scope ID 的鏈路本地 IPv6 位址，使用預設端口。 例如："[fe80::208:96ff:fe40:9b04%12]" [<Link-local IPv6>%<interface>]:<port> 鏈路本地 IPv6 與 scope ID 和端口。 例如："[fe80::208:96ff:fe40:9b04%12]:3007" TCP:[<Link-local IPv6>%<interface>]:<port> 明確指定 TCP、鏈路本地 IPv6、scope ID、端口。 例如："TCP:[fe80::208:96ff:fe40:9b04%12]:3007"

實作 IComm.

DescriptorValidate()

static String DescriptorValidate ( String  descriptorHint, DescriptorPortType  portTypeHint  )

static

從可能有或沒有端口的 descriptorHint 驗證/構建描述符字串。返回有效的描述符或空的 "" 字串。

descriptorHint 接受的值：

• 僅 IPv4：#.#.#.#
  • 根據 portTypeHint 使用預設端口
• IPv4 + 端口：#.#.#.#:p，其中 p = 端口號
• TCP + IPv4：TCP:#.#.#.#
  • 根據 portTypeHint 使用預設端口
• TCP + IPv4 + 端口：TCP:#.#.#.#:p
• 僅 IPv6：[xxxx:xxxx::xxxx]
  • 根據 portTypeHint 使用預設端口
• IPv6 + 端口：[xxxx:xxxx::xxxx]:p
• TCP + IPv6：TCP:[xxxx:xxxx::xxxx]
  • 根據 portTypeHint 使用預設端口
• TCP + IPv6 + 端口：TCP:[xxxx:xxxx::xxxx]:p
• 含有範圍 ID 的 Link-local IPv6：[fe80::xxxx介面]
  • 可有可無端口，例如：[fe80::1wlan0]
  • 也支援 TCP 前綴：TCP:[fe80::1wlan0]:3007

WaitForData()

void WaitForData ( int  msTimeOut )

inherited

等待當前執行緒有可用的資料 BytesAvailable。當前執行緒會休眠直到收到資料或超時為止。此為阻塞呼叫。

參數

[in]

msTimeOut

在沒有收到資料前返回的毫秒超時。

實作 IComm.

Write()

void Write ( InputStream  binReader ) throws IOException

inherited

從輸入流寫入輸出流。

參數

[in]

binReader

要傳送的來源資料。

實作 IComm.

WriteAndWaitForResponse() [1/2]

byte [] WriteAndWaitForResponse ( byte[]  dataOut, int  responseStartTimeOut, int  responseEndTimeOut, String  completionToken  ) throws IOException

inherited

將位元組資料寫入輸出流並返回接收到的資料。返回的資料是接收到的任何資料或收到的完成標記。等待回應超時後返回。

傳回值

byte[]

從連接接收到的位元組陣列。 返回的資料是接收到的任何資料或收到的完成標記。

參數

[in]	dataOut	要寫入連接的來源位元組陣列。
[in]	responseStartTimeOut	等待接收到第一個資料的超時。從第一個字節開始計時。
[in]	responseEndTimeOut	沒有新資料接收的超時。從最後一個字節後開始計時。
[in]	completetionToken	標示預期回應結束的字串標記。如果只是想在寫入資料到連接後等待回應，可以是空字串。

實作 IComm.

WriteAndWaitForResponse() [2/2]

void WriteAndWaitForResponse ( OutputStream  binDataIn, InputStream  binDataOut, int  responseStartTimeOut, int  responseEndTimeOut, String  completionToken  ) throws IOException

inherited

將 binDataOut 流資料寫入輸出流，並將接收到的資料返回到 binDataIn 流中。返回的資料是收到的資料或收到的完成標記。等待回應超時後返回。

參數

[out]	binDataIn	用於存儲從連接接收到的回應的目標流。
[in]	binDataOut	寫入連接的來源流資料。
[in]	responseStartTimeOut	等待接收到第一個資料的超時。從第一個字節開始計時。
[in]	responseEndTimeOut	沒有新資料接收的超時。從最後一個字節後開始計時。
[in]	completetionToken	標示預期回應結束的字串標記。如果只是想在寫入資料到連接後等待回應，可以是空字串。

實作 IComm.

資料成員說明文件

DEFAULT_STATUS_PORT

final int DEFAULT_STATUS_PORT = 3002

static

Port for listening to status messages from printer.

打印機可根據打印機上的「Ret. Status Port」設定將狀態消息發送到不同的端口。 如果「Ret. Status Port」設置為「E-NET Stat Port」，則打印機可能會將狀態消息發送到「Status Port Number」設定，預設為 3002。

例如：打印機語言（如 PGL）的模擬診斷消息。

例如：使用以下打印機菜單設置捕獲 ODV 條碼數據和等級：

• 將「System/Printer Mgmt/Ret. Status Port」設為「E-NET Stat Port」
• 將「System/Printer Mgmt/Status Port Number」設為 3002
• 將「ODV2D/Control/Telemetry Data」設為「Full Report」
• 將「ODV2D/Control/Return Data」設為「Data+Grade」，以便監聽「條碼數據 + 等級」