프라우드넷 스터디 1

프라우드넷 설치

프라우드넷 도움말

일단 프라우드넷을 익히기 위해 유니티 프라우드넷 튜토리얼 동영상 참고 합니다. 

이 튜토리얼을 통해 프라우드넷 동작을 익히며 함수를 수정하여 프로젝트에 적용할 예정입니다.

다음에 다시 작업할 때 기억하기 위해 홈페이지에 기록해 둡니다.

1. GameObject 생성 및 스크립트 추가 (언리얼 엔진에서는 일단 Actor 클래스에서 상속받아서 클래스 생성)

2. GUI로 버튼과 TextFiled등을 생성 (언리얼 엔진에서는?)

3. ProudDotNetClient.dll을 Assets 폴더에 포함 (언리얼 엔진에서는?)

   프라우드넷 모듈을 유니티에서 바로 사용 가능합니다. 요점은 프라우드넷 API 사용을 위한 라이브러리 설정입니다.

유니티 클라이언트 코드 입니다.

주요 함수로는 Update()에 m_netClient.FrameMove() 함수, m_netClient.Connect()에 NetConnectionParam 설정후 매개변수로 설정. 프로토콜 버전에 new Guid("띄어쓰기 불가") 설정이 있습니다.

OnGUI에서 현재 상태를 보여주고 있습니다.

GameClient.cs

using UnityEngine; using Nettention.Proud; public class GameClient : MonoBehaviour { private void Awake() { m_netClient = new NetClient(); } private void OnDestroy() { m_netClient.Dispose(); } // Update is called once per frame void Update () { // receives message and events. you don't have to call this fuction too frequently. // 서버에서 도착하는 메시지나 이벤트를 처리하는 함수. 호출해 주어야 이벤트가 콜백이 됨. if (m_netClient != null) m_netClient.FrameMove(); } string m_strServerAddr = "localhost"; string m_strVilleName = "Janna"; bool m_bRequestNewVille = false; string m_strLoginButtonText = "Connect!"; enum eState { Standby, Connecting, LoggingOn, InVille} eState m_eState; // 요점 NetClient m_netClient = null; private void OnGUI() { GUI.Label(new Rect(10, 10, 300, 70), "ProudNet example:\na simple social ville"); GUI.Label(new Rect(10, 60, 180, 30), "Server address"); m_strServerAddr = GUI.TextField(new Rect(10, 80, 180, 30), m_strServerAddr); GUI.Label(new Rect(10, 10, 300, 70), "ProudNet example:\na simple social ville"); m_strVilleName = GUI.TextField(new Rect(10, 130, 180, 30), m_strVilleName); m_bRequestNewVille = GUI.Toggle(new Rect(10, 160, 180, 20), m_bRequestNewVille, "Create a new Ville"); if (GUI.Button(new Rect(10, 190, 100, 30), m_strLoginButtonText)) { if (m_eState == eState.Standby) { m_eState = eState.Connecting; m_strLoginButtonText = "Connecting..."; IssueConnect(); } } } void IssueConnect() { // 서버 로그인 완료 후 이벤트 (람다식 구현) m_netClient.JoinServerCompleteHandler = (ErrorInfo info, ByteArray replyFromServer) => { if (info.errorType == ErrorType.ErrorType_Ok) { m_strLoginButtonText = "Connected!"; } else { m_strLoginButtonText = "Failed!"; } }; m_netClient.LeaveServerHandler = (ErrorInfo info) => { m_strLoginButtonText = "LEFT!!!!"; }; // asynchronous connect NetConnectionParam cp = new NetConnectionParam(); cp.serverIP = m_strServerAddr; cp.serverPort = 12349; // 프로토콜 버전 : 서버랑 클라이언트랑 버전이 같은지 판별, 두 버전이 같을 때만 접속이 허가됩니다. cp.protocolVersion = new Guid("{0xec187df7,0xf7e8,0x47c4,{0xbb,0xc9,0x37,0xd6,0x3d,0xfc,0xb3,0x82}}"); // 이 함수는 비동기로 실행됩니다. 그래서 호출을 하면 바로 리턴하고 백그라운드로 서버와 연결이 진행됩니다. m_netClient.Connect(cp); } } /* NOTE: 일반적으로 게임 서버는 여러대로 만드는 경우가 많습니다. 클라이언트에서는 서버의 주소를 여러개 가지고 있거나 로드밸런스(?)를 이용하기도 합니다. */

도구 > GUID 만들기

다음으로 유니티 StudyNetwork 솔루션에 C++ 서버 프로젝트를 생성하고 라이브러리 설정을 Debug, Release로 합니다.

http://guide.nettention.com/tutorial_ko#66760aeaf35109cf

서버용 클래스를 하나 만듭니다. 여기에서 요점은 CNetServer 클래스를 사용하는 것과 INetServerEvent를 상속받아서 순수 가상함수들을 구현해 주는 것입니다. 

CNetServer::Create()로 객체를 생성하며 서버 파라메터 설정 후 Start()를 해야 서버가 동작합니다.

나머지는 주석처리 해놓았습니다.

코드를 읽다보면 유저가 접속했을 때 printf문으로 문자열 출력 처리를 해주고 있습니다.

ServerStudy.h

#pragma once class CServerStudy : public INetServerEvent // 서버에서 발생하는 여러가지 이벤트 콜백들을 처리할 수 있는 인터페이스 상속 { CNetServer* m_pNetServer; public: CServerStudy(); ~CServerStudy(); // 서버를 시작합니다. void Start(); // INetServerEvent을(를) 통해 상속됨 virtual void OnError(ErrorInfo * errorInfo) override; virtual void OnWarning(ErrorInfo * errorInfo) override; virtual void OnInformation(ErrorInfo * errorInfo) override; virtual void OnException(const Exception & e) override; virtual void OnNoRmiProcessed(RmiID rmiID) override; // 클라이언트가 서버에 접속했습니다. virtual void OnClientJoin(CNetClientInfo * clientInfo) override; // 클라이언트가 서버 접속을 해제했습니다. virtual void OnClientLeave(CNetClientInfo * clientInfo, ErrorInfo * errorinfo, const ByteArray & comment) override; virtual void OnP2PGroupJoinMemberAckComplete(HostID groupHostID, HostID memberHostID, ErrorType result) override; virtual void OnUserWorkerThreadBegin() override; virtual void OnUserWorkerThreadEnd() override; };

ServerStudy.cpp

#include "stdafx.h" #include "ServerStudy.h" CServerStudy::CServerStudy() { m_pNetServer = CNetServer::Create(); // 이벤트가 발생하면 처리할 클래스로 이 클래스를 지정 m_pNetServer->SetEventSink(this); } CServerStudy::~CServerStudy() { delete m_pNetServer; } void CServerStudy::Start() { ErrorInfoPtr err; CStartServerParameter sp; sp.m_protocolVersion = Guid::From({0xec187df7,0xf7e8,0x47c4,{0xbb,0xc9,0x37,0xd6,0x3d,0xfc,0xb3,0x82}}); sp.m_tcpPorts.Add(12349); m_pNetServer->Start(sp, err); } void CServerStudy::OnError(ErrorInfo * errorInfo) { printf("%s: %s\n", __FUNCTION__, StringW2A(errorInfo->ToString())); } void CServerStudy::OnWarning(ErrorInfo * errorInfo) { printf("%s: %s\n", __FUNCTION__, StringW2A(errorInfo->ToString())); } void CServerStudy::OnInformation(ErrorInfo * errorInfo) { printf("%s: %s\n", __FUNCTION__, StringW2A(errorInfo->ToString())); } void CServerStudy::OnException(const Exception & e) { } void CServerStudy::OnNoRmiProcessed(RmiID rmiID) { } void CServerStudy::OnClientJoin(CNetClientInfo * clientInfo) { // 클라이언트 접속시 서버 처리 부분 printf("%s: %d\n", __FUNCTION__, clientInfo->m_HostID); } void CServerStudy::OnClientLeave(CNetClientInfo * clientInfo, ErrorInfo * errorinfo, const ByteArray & comment) { // 클라이언트 접속 해제시 서버 처리 부분 printf("%s: %d\n", __FUNCTION__, clientInfo->m_HostID); } void CServerStudy::OnP2PGroupJoinMemberAckComplete(HostID groupHostID, HostID memberHostID, ErrorType result) { } void CServerStudy::OnUserWorkerThreadBegin() { } void CServerStudy::OnUserWorkerThreadEnd() { }

서버를 실행하고 유니티에서 Connect버튼을 누르면 클라이언트가 서버에 접속하는 것을 볼 수 있습니다.

여기까지 하면 동영상 2번이 끝납니다.

PIDL

다음 3번째 영상에서 PIDL을 만듭니다.

Visual Studio에서 새 파일 > txt를 만들고 확장자를 pidl로 만들면 됩니다.

아래에서 메시지 번호를 3000번대 4000번대를 사용하겠다고 선언해 주는데 PIDL을 작성하면서 문법에 맞지 않으면(3000 누락) 나중에 PIDL 컴파일시 no viable alternative at input { 에러를 냅니다.

그 다음 만들어진 pidl 파일을 빌드해주기 위해서 파일 우클릭 > 속성으로 갑니다.

항목 형식을 사용자 지정 빌드 도구로 합니다.

pidl 파일 빌드 별로 어렵지 않습니다.

pidl.exe 파일은 Social.pidl 파일을 .h .cpp나 .cs파일로 변환해주는 유틸리티 파일입니다.

1. 명령줄 : 프라우드넷이 설치된 F:\Program Files (x86)\Nettention\ProudNet\util\pidl.exe 에 절대경로로 접근할 수 없습니다. 띄어쓰기된 폴더명 때문입니다. 그래서 pidl.exe파일 하나만 그냥 복사해와서 사용합니다.

%(Fullpath)는 Social.pidl 파일의 경로이고 -cs를 입력해서 -outdir을 지정하면 C#파일들로 만들어집니다.

2. 설명 : Compiling ~~

3. 출력 : 나오는 파일 경로와 이름입니다.

4. 추가 종속성에 pidl.exe 파일의 경로를 입력해 줍니다.

프로젝트를 빌드해 주면 컴파일이 됩니다.

빌드를 하면 명령줄에서 작성했듯 2가지 파일들 즉, 서버쪽 C++파일과 클라이언트(유니티)쪽 C#파일들이 생성됩니다.

빌드시 자동으로 생성되는 파일들이기 때문에 수정할 필요가 없습니다.

여기에서 Proxy와 Stub의 개념이 도움말에 보면 나옵니다.

여기서 우리는 몇 가지 용어를 이해해야 합니다. 앞서 IDL 파일을 컴파일하면 생성되는 파일들이 있다고 언급했는데, 그 파일 중 함수 호출을 메시지로 바꾸어 네트웍으로 보내는 모듈을 proxy라고 부르며 네트웍을 통해 받은 메시지를 분석해서 유저 함수를 호출하는 모듈을 stub이라고 부릅니다.

서버에 접속이 되었으면 위에서 만들어 놓은 함수를 사용하여 RequestLogon을 보냅니다. 

그리고 수정되는 부분은 Proxy, Stub 객체를 생성하고 NetClient에 붙이는(Attach) 것입니다.

수정되는 사항

GameClient.cs

void IssueConnect() { // 서버 로그인 완료 후 이벤트 (람다식 구현) m_netClient.JoinServerCompleteHandler = (ErrorInfo info, ByteArray replyFromServer) => { if (info.errorType == ErrorType.ErrorType_Ok) { m_eState = eState.LoggingOn; m_szLoginButtonText = "Logging on..."; m_C2SProxy.RequestLogon(HostID.HostID_Server, RmiContext.ReliableSend, m_szVilleName, m_bRequestNewVille); } else { m_szLoginButtonText = "Failed!"; } }; ... /// <summary> /// ProudNet NetClient /// </summary> NetClient m_netClient = null; /// <summary> /// ProudNet Proxy /// </summary> SocialC2S.Proxy m_C2SProxy = new SocialC2S.Proxy(); /// <summary> /// ProudNet Stub /// </summary> SocialS2C.Stub m_S2CStub = new SocialS2C.Stub(); private void Awake() { m_netClient = new NetClient(); } void Start() { m_netClient.AttachProxy(m_C2SProxy); m_netClient.AttachStub(m_S2CStub); }

클라이언트에서 RequestLogon을 보냈으니 서버에서 이 메시지를 받아서 처리 한다음 응답해야 합니다.

유심히 봐야할 것은

C2S 클라에서 서버로 보낸 메시지는 Stub이고

S2C 서버에서 클라로 보낼 메시지는 Proxy입니다.

그리고 DECRMI와 DEFRMI의 미묘한 함수명 차이가 있습니다.

그리고 PIDL로 생성된 파일들을 프로젝트에 추가하고 그 파일들을 모두 빌드에서 제외 시켜줍니다.

ServerStudy.h 에 추가된 내용은 다음과 같습니다.

1. #include에서 PIDL로 생성된 Social_common.h, Social_proxy.h, Social_stub.h를 포함.

2. 클라이언트에서 받은 메시지를 처리, SocialC2S::Stub의 함수를 구현하기 위해 상속받음.

3. 서버에서 보내주는 메시지를 처리, SocialS2C::Proxy m_S2CProxy; 선언

4. DECRMI_SocialC2S_RequestLogon 선언

ServerStudy.cpp 에 추가된 내용은 다음과 같습니다.

1. DEFRMI_SocialC2S_RequestLogon 구현, 응답시 처리해줘야 하는 내용은 아직 없네요.

2. 생성자에서 AttachProxy, AttachStub

그리고 빌드를 해주기 위해 헤더 파일 없이 PidlInclude.cpp 파일 하나를 만들어 줍니다.

ServerStudy.h

#pragma once #include "PIDL/Social_common.h" #include "PIDL/Social_proxy.h" #include "PIDL/Social_stub.h" class CServerStudy : public INetServerEvent, // 서버에서 발생하는 여러가지 이벤트 콜백들을 처리할 수 있는 인터페이스 상속 public SocialC2S::Stub { CNetServer* m_pNetServer; SocialS2C::Proxy m_S2CProxy; public: // ... DECRMI_SocialC2S_RequestLogon; };

ServerStudy.cpp

#include "stdafx.h" #include "ServerStudy.h" CServerStudy::CServerStudy() { m_pNetServer = CNetServer::Create(); // 이벤트가 발생하면 처리할 클래스로 이 클래스를 지정 m_pNetServer->SetEventSink(this); m_pNetServer->AttachProxy(&m_S2CProxy); m_pNetServer->AttachStub(this); } // ... DEFRMI_SocialC2S_RequestLogon(CServerStudy) { // remote is the message sender client. we are replying. m_S2CProxy.ReplyLogon(remote, RmiContext::ReliableSend, 0, L""); return true; // must always true! }

PidlInclude.cpp

#include "stdafx.h" #include "PIDL\Social_common.cpp" #include "PIDL\Social_proxy.cpp" #include "PIDL\Social_stub.cpp"

여기까지 해서 클라에서 로그온 요청을 보내면 서버에서 응답해 줍니다.

그럼 서버에서 응답해주면 클라에서 처리를 해야 합니다.

응답시 State를 바꿔서 InVille로 들어가게끔 처리해 줍니다.

다음은 ReplyLogon함수 구현과 OnGUI함수를 정리한 정도 입니다.

GameClient.cs

using UnityEngine; using Nettention.Proud; public class GameClient : MonoBehaviour { string m_szServerAddr = "localhost"; string m_szVilleName = "Janna"; string m_szLoginButtonText = "Connect!"; string m_szFailMessage = ""; bool m_bRequestNewVille = false; enum eState { Standby, Connecting, LoggingOn, InVille, Failed } eState m_eState; /// <summary> /// ProudNet NetClient /// </summary> NetClient m_netClient = null; /// <summary> /// ProudNet Proxy /// </summary> SocialC2S.Proxy m_C2SProxy = new SocialC2S.Proxy(); /// <summary> /// ProudNet Stub /// </summary> SocialS2C.Stub m_S2CStub = new SocialS2C.Stub(); private void Awake() { m_netClient = new NetClient(); } void Start() { m_netClient.AttachProxy(m_C2SProxy); m_netClient.AttachStub(m_S2CStub); // 서버 로그인 완료 후 이벤트 m_netClient.JoinServerCompleteHandler = JoinServerCompleteHandler; m_netClient.LeaveServerHandler = LeaveServerHandler; // RequestLogon 후 이벤트 m_S2CStub.ReplyLogon = ReplyLogon; } private void OnDestroy() { m_netClient.Dispose(); } // Update is called once per frame void Update () { // receives message and events. you don't have to call this fuction too frequently. // 서버에서 도착하는 메시지나 이벤트를 처리하는 함수. 호출해 주어야 이벤트가 콜백이 됨. if (m_netClient != null) m_netClient.FrameMove(); } private void OnGUI() { switch (m_eState) { case eState.Standby: case eState.Connecting: case eState.LoggingOn: OnGUI_Logon(); break; case eState.InVille: break; case eState.Failed: OnGUI_Failed(); break; } } void OnGUI_Logon() { GUI.Label(new Rect(10, 10, 300, 70), "ProudNet example:\na simple social ville"); GUI.Label(new Rect(10, 60, 180, 30), "Server address"); m_szServerAddr = GUI.TextField(new Rect(10, 80, 180, 30), m_szServerAddr); GUI.Label(new Rect(10, 10, 300, 70), "ProudNet example:\na simple social ville"); m_szVilleName = GUI.TextField(new Rect(10, 130, 180, 30), m_szVilleName); m_bRequestNewVille = GUI.Toggle(new Rect(10, 160, 180, 20), m_bRequestNewVille, "Create a new Ville"); if (GUI.Button(new Rect(10, 190, 100, 30), m_szLoginButtonText)) { if (m_eState == eState.Standby) { m_eState = eState.Connecting; m_szLoginButtonText = "Connecting..."; IssueConnect(); } } } void OnGUI_Failed() { GUI.Label(new Rect(10, 30, 200, 80), m_szFailMessage); if (GUI.Button(new Rect(10, 100, 180, 30), "Quit")) Application.Quit(); } void IssueConnect() { // asynchronous connect NetConnectionParam cp = new NetConnectionParam(); cp.serverIP = m_szServerAddr; cp.serverPort = 12349; // 프로토콜 버전 : 서버랑 클라이언트랑 버전이 같은지 판별, 두 버전이 같을 때만 접속이 허가됩니다. cp.protocolVersion = new Guid("{0xec187df7,0xf7e8,0x47c4,{0xbb,0xc9,0x37,0xd6,0x3d,0xfc,0xb3,0x82}}"); // 이 함수는 비동기로 실행됩니다. 그래서 호출을 하면 바로 리턴하고 백그라운드로 서버와 연결이 진행됩니다. m_netClient.Connect(cp); } // Request, Response public void JoinServerCompleteHandler(ErrorInfo info, ByteArray replyFromServer) { if (info.errorType == ErrorType.ErrorType_Ok) { m_eState = eState.LoggingOn; m_szLoginButtonText = "Logging on..."; m_C2SProxy.RequestLogon(HostID.HostID_Server, RmiContext.ReliableSend, m_szVilleName, m_bRequestNewVille); } else { m_szLoginButtonText = "Failed!"; } } public void LeaveServerHandler(ErrorInfo info) { m_szLoginButtonText = "LEFT!!!!"; m_szFailMessage = "Server connection lost!"; } public bool ReplyLogon(Nettention.Proud.HostID remote, Nettention.Proud.RmiContext rmiContext, int result, string comment) { switch (result) { case 0: m_eState = eState.InVille; break; default: m_eState = eState.Failed; m_szFailMessage = "Logon failed: " + result.ToString() + " " + comment; break; } return true; } } /* NOTE: 일반적으로 게임 서버는 여러대로 만드는 경우가 많습니다. 클라이언트에서는 서버의 주소를 여러개 가지고 있거나 로드밸런스(?)를 이용하기도 합니다. */

다음은 서버를 켜고(실행) 클라이언트 유니티에서 접속한 후 화면입니다.

여기까지 하면 튜토리얼 동영상의 3장이 끝납니다.