TCP/IP Network Client 측 통신 프로그램 작성시 발생될 수 있는 여러가지 예외 처리 및 프로토콜에 의한 송수신시 필요한 처리를 별도로 작성할 수 있도록 만들어진 Wrapping Class를 제공하고있습니다. 따라서 개발자는 SmartTCPClient-Wrapping Class를 재사용하여 필요한 부분만을 수정 및 적용하므로 프로그램을 편리하게 작성할 수 있습니다. 개발자는 Wrapping Class 적용을 위하여 대부분 사용자 정의 영역의 코드를 재정의 및 수정하시면 됩니다. Wrapping Class는 SmartTCPClient Component를 기반으로 연동하여 동작 합니다.

본문을 확인하여 프로젝트에 SmartTCPClient-Wrapping Class를 적용해보시기 바라며, 적용이 어려우신 경우 원격으로 적용을 도와드리도록 하겠습니다.

SmartTCPClient-Wrapping Class는 크게 미리 정의된 영역과, 사용자가 코드를 수정해야 하는 사용자 정의 영역으로 나눌 수 있습니다. 사용자 정의 영역에서 상황 별 사용자가 수정해야 하는 메서드는 다음과 같습니다. 특히, Send, Receive 부분은 반드시 사용자의 프로토콜에 맞도록 코드를 작성해야 합니다.

• ※ Connect 동작 관련

• 인터페이스	void ConnectRetryFail_User(NetworkConnectStatus eNetworkStatus)
  권장동작	최종적으로 Connect에 실패 한 경우 NetworkConnectStatus 열거값에 따라 Connect 재시도 또는 Connect 실패 원인을 사용자에게 알리는 처리를 하도록 작성합니다.
  현재 동작	ConnectMaxRetryCount로 지정한 횟수 만큼 Connect를 시도했으나, 서버와 연결에 실패한 경우 호출되며, 인자값으로 전달받은 네트워크 상태에 따라 Connect를 재시도 하거나, 네트워크 상태에 따른 처리 방법을 메시지 박스에 출력합니다.

• ※ Send (Request-Response) 동작 관련

• 인터페이스	Data_Packet Command_RequestResponse(string strCommand, int iCh, byte[] chData)
  권장동작	사용하는 프로토콜에 따라 인자 형식을 변경하고, Request 결과(SendStatus)에 따라 Response 수신 처리 작성과, Request 실패 처리를 작성합니다.
  현재 동작	Server로 Command에 따른 데이터 전송(Request) 후 Server 의 응답(Response)을 수신받을 때까지 대기하고 Request-Response 과정의 결과(CommandStatus)를 리턴 하도록 처리함
  인터페이스 SendStatus Request_Command(string strCommand, int iCh, byte[] chData) 권장동작 사용하는 프로토콜에 맞게 인자 형식을 변경하고 프레임을 구성하여 Server로 Request 전송 처리하는 과정을 작성합니다. 현재 동작 예제 프로토콜에 맞도록 프레임 구성 후 Server로 데이터를 전송(Request)하고, 데이터 전송 상태(SendStatus)를 리턴 하도록 처리함 인터페이스 Data_Packet Response_Parsing(byte[] chData, bool bAckRecv) 권장동작 수신받은 Response 데이터나 Server에서 임의의 시점에 수신받은 데이터(Server Event Data)를 사용하는 프로토콜에 맞게 검증 후 파싱하여 구조체 데이터에 저장하는 과정을 작성합니다. 현재 동작 Request 후 Server로부터 응답(Response)받거나, 임의의 시점에 수신받은(Server Event Data) 데이터를 사용자의 프로토콜에 맞게 검증 및 파싱 후 데이터 패킷(Data_Packet)을 구성하여 (채워넣어) 리턴 하도록 처리함

  인터페이스	void ACK_OnReceiveHandler_User(byte[] receiveData)
  권장동작	Request 전송 후 올바르게 Response 수신 받았을 때의 처리를 작성합니다. Response 수신 완료 처리 및 사용자의 프로토콜에 맞게 처리 코드를 작성합니다.
  현재 동작	현재 코드는 공란입니다. ※ 특별한 경우가 아니라면 사용하지 않습니다.

• ※ Receive (Sever Event Send) 동작 관련

• 인터페이스	void OnReceiveHandler_User(byte[] receiveData)
  권장동작	서버에서 임의의 시점에 데이터(Server Event Data)를 수신 받았을 때의 처리를 작성합니다. Server Event Data 수신 알림 및 사용자의 프로토콜에 맞게 처리 코드를 작성합니다.
  현재 동작	현재 코드는 공란입니다. ※ 특별한 경우가 아니라면 사용하지 않습니다.

SmartTCPClient-Wrapping Class에서 연결 방식은 동기/비동기 방식이 있으며, Connect 실패 시 재시도 회수와 간격을 설정할 수 있습니다. 또한 Network 상태를 확인하는 기능을 이용하여 현재 Network가 가용 상태인지 확인할 수 있습니다. 서버 연결 구조는 아래 그림과 같습니다.

SmartTCPClient-Wrapping Classs에서 기본적인 통신 구조는 두가지 모델을 지원하고있습니다.

CASE-1] 요청(Request/Send) and 응답(Response/Receive) 구성

요청-응답(Request-Response)구조는 Client에서 Server로 데이터를 요청하면 Server는 반드시 Client로 응답을 전송해야 하는 구조로, 송/수신 구조는 아래 그림과 같습니다.

A) 사용자 수정 영역

Command_RequestResponse() 메서드는 사용자의 프로토콜에 따른 Request-Response 동작을 하는 메서드로, 내부에서 Request_Command() 메서드를 호출하여 서버로 프로토콜에 따른 Request 프레임 전송 후 미리 정의 된 상수 ACKTIMEOUT 시간동안 서버의 Response 프레임 수신을 대기하며 Command_RequestResponse() 메서드로 데이터 전송 상태를 리턴합니다.
서버로부터 Response 프레임이 수신되었다면, ACK_OnReceiveHandler_User() 메서드가 호출되어 사용자가 원하는 처리를 할 수 있습니다.
또한 Command_RequestResponse() 메서드 내부에서 Response_Parsing() 메서드가 호출되어 수신받은 Response 프레임을 프로토콜에 맞게 파싱(Parsing)작업을 진행합니다.
따라서 사용자는 Command_RequestResponse(),Request_Command(),Response_Parsing() 메서드의 코드를 사용자의 프로토콜에 맞도록 수정하는 작업이 반드시 필요합니다.

[기본 로직]

※ 메서드(함수)
인터페이스명	Request_Command
설명	사용자의 프로토콜에 맞는 프레임 구성 후 Server로 데이터를 전송하고, 데이터 전송 상태(SendStatus)를 리턴하는 메서드 [SendStatus 리턴 값] • Success : 데이터 전송 후 서버로부터 응답을 받음 • ConnectionFailed : 서버와 연결되지 않음 • SendFailed : 데이터 전송에 실패 (Send관련 메서드에서 False리턴) • AckFailed : 데이터 전송에 성공했으나, 서버로부터 응답이 오지 않음 ⊙ SendStatus Request_Command(string strCommand, int iCh, byte[] chData)

인터페이스명	Response_Parsing
설명	Request 후 Server로부터 응답(Response)받거나, 임의의 시점에 수신받은 (Server Event Data) 데이터를 사용자의 프로토콜에 맞게 검증 및 파싱 후 데이터 패킷(Data_Packet)을 구성하여 리턴하는 메서드 [Data_Packet 구조체 멤버] • public byte[] chCommand: 송수신한 Command를 저장 • public byte chChannel: 송수신한 Channel을 저장 • public byte[] chData: 송수신한 Data를 저장 • public CommandStatus chCommandStatus: 수신받은 데이터의 상태를 저장 ⊙ Data_Packet Response_Parsing(byte[] chData, bool bAckRecv)

인터페이스명	ACK_OnReceiveHandler_User
설명	서버로 Request 후 정상적으로Response 받은 경우 발생하는 메서드 ⊙ void ACK_OnReceiveHandler_User(byte[] receiveData)

[외부 인터페이스]

※ 메서드(함수)
인터페이스명	Command_RequestResponse
설명	Server로 Command에 따른 데이터 전송(Request) 후 Server 의 응답(Response)을 수신받을 때까지 대기하고 Request-Response 과정의 결과(CommandStatus)를 리턴하는 메서드 [Data_Packet 구조체 멤버] • public byte[] chCommand : 송수신한 Command를 저장 • public byte chChannel : 송수신한 Channel을 저장 • public byte[] chData : 송수신한 Data를 저장 • public CommandStatus chCommandStatus : 수신받은 데이터의 상태를 저장 ⊙ Data_Packet Command_RequestResponse(string strCommand, int iCh, byte[] chData)

B) 미리 정의된 영역 [기본 로직]

명칭	리턴값	설명
SmartTCPClient_SendData()	bool	실제 Server로 데이터를 전송하는 메서드로 데이터 전송 후 ACK 응답 (Response)이 수신될 때 까지 대기 합니다.
SmartTCPClient_OnReceiveHandler()	void (Event Method)	Server로부터 데이터를 수신받을 때 발생하는 이벤트로 수신받은 데이터를 List에 저장하고 ACK응답 수신성공 처리를 합니다.

[외부 인터페이스]

※ 메서드(함수)
인터페이스명	SendData
설명	Server로 데이터 전송 후 전송 상태를 리턴합니다. [SendStatus 리턴 값] • Success : 데이터 전송 후 서버로부터 응답을 받음 • ConnectionFailed : 서버와 연결되지 않음 • SendFailed : 데이터 전송에 실패 (Send관련 메서드에서 False리턴) • AckFailed : 데이터 전송에 성공했으나, 서버로부터 응답이 오지 않음 ⊙ SendStatus SendData(byte[] sendData)

CASE-2] Server Event Data 수신

Client의 Request 전송과 관계없이 Server로부터 임의의 시점에 데이터를 수신받는 경우이며, 수신 구조는 아래 그림과 같습니다.

A) 사용자 수정 영역

서버로부터 임의의 시점에 데이터가 수신되면 OnReceiveHandler_User() 메서드가 호출되어 사용자가 원하는 처리를 할 수 있으며, 수신받은 데이터는 Response_Parsing() 메서드에서 사용자의 프로토콜에 맞게 파싱되어 Data Queue인 m_EventResponsePacket 에 저장(Enqueue)됩니다.
사용자는 GetServerEventReceiveQueueCount 프로퍼티(속성)을 확인하여 Queue에 데이터가 있다면 GetServerEventReceiveQueue() 메서드를 호출하여 수신받은 데이터를 가져올(Dequeue) 수 있습니다.

[기본로직] ※ Server Event Data Receive Queue

명칭	자료형	설명
m_EventResponsePacket	Data_Packet	서버에서 임의로 송신한 데이터를 저장할 Queue
SmartTCPClient_OnReceiveHandler()	void (Event Method)	Server로부터 데이터를 수신받을 때 발생하는 이벤트로 수신받은 데이터를 List에 저장하고 ACK응답 수신성공 처리를 합니다.

※ 메서드(함수)
인터페이스명	OnReceiveHandler_User
설명	Server로부터 임의의 시점에 데이터가 수신될 경우 발생하는 메서드(Server Event Data 처리) ⊙ void OnReceiveHandler_User(byte[] receiveData)

인터페이스명	Response_Parsing
설명	Request 후 Server로부터 응답(Response)받거나, 임의의 시점에 수신받은 (Server Event Data) 데이터를 사용자의 프로토콜에 맞게 검증 및 파싱 후 데이터 패킷(Data_Packet)을 구성하여 리턴하는 메서드 [Data_Packet 구조체 멤버] • public byte[] chCommand: 송수신한 Command를 저장 • public byte chChannel: 송수신한 Channel을 저장 • public byte[] chData: 송수신한 Data를 저장 • public CommandStatus chCommandStatus: 수신받은 데이터의 상태를 저장 ⊙ Data_Packet Response_Parsing(byte[] chData, bool bAckRecv)

[외부 인터페이스]

※ 프로퍼티(속성)
인터페이스명	GetServerEventReceiveQueueCount
설명	Queue에 저장된 패킷의 수를 읽습니다.

※ 메서드(함수)
인터페이스명	GetServerEventReceiveQueue
설명	Queue에 저장된 패킷을 가져옵니다.(Dequeue) [Data_Packet 구조체 멤버] • public byte[] chCommand: 송수신한 Command를 저장 • public byte chChannel: 송수신한 Channel을 저장 • public byte[] chData: 송수신한 Data를 저장 • public CommandStatus chCommandStatus: 수신받은 데이터의 상태를 저장 ⊙ Data_Packet GetServerEventReceiveQueue()

B) 미리 정의된 영역

명칭	자료형	설명
SmartTCPClient_OnReceiveHandler()	void (Event Method)	Server로부터 데이터를 수신받을 때 발생하는 이벤트로 수신받은 데이터를 Queue에 저장 (Enqueue)하고, 사용자 처리 메서드를 발생시킵니다.

TCP/IP 통신 중 다양한 통신 에러가 발생할 수 있으며 유형에 따른 확인 항목을 안내합니다.