1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Client for wxSocket demo
4 // Author: Guillermo Rodriguez Garcia <guille@iies.es>
8 // Copyright: (c) 1999 Guillermo Rodriguez Garcia
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ==========================================================================
14 // ==========================================================================
16 // --------------------------------------------------------------------------
18 // --------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx/wx.h".
21 #include "wx/wxprec.h"
27 // for all others, include the necessary headers
32 #include "wx/socket.h"
34 #include "wx/sstream.h"
37 // --------------------------------------------------------------------------
39 // --------------------------------------------------------------------------
41 // the application icon
42 #include "mondrian.xpm"
44 // --------------------------------------------------------------------------
46 // --------------------------------------------------------------------------
48 // Define a new application type
49 class MyApp
: public wxApp
52 virtual bool OnInit();
55 // Define a new frame type: this is going to be our main frame
56 class MyFrame
: public wxFrame
62 // event handlers for File menu
63 void OnQuit(wxCommandEvent
& event
);
64 void OnAbout(wxCommandEvent
& event
);
66 // event handlers for Socket menu
67 void OnOpenConnection(wxCommandEvent
& event
);
68 void OnTest1(wxCommandEvent
& event
);
69 void OnTest2(wxCommandEvent
& event
);
70 void OnTest3(wxCommandEvent
& event
);
71 void OnCloseConnection(wxCommandEvent
& event
);
74 // event handlers for Protocols menu
75 void OnTestURL(wxCommandEvent
& event
);
78 void OnOpenConnectionIPv6(wxCommandEvent
& event
);
81 void OpenConnection(wxSockAddress::Family family
);
83 // event handlers for DatagramSocket menu (stub)
84 void OnDatagram(wxCommandEvent
& event
);
86 // socket event handler
87 void OnSocketEvent(wxSocketEvent
& event
);
89 // convenience functions
90 void UpdateStatusBar();
93 wxSocketClient
*m_sock
;
97 wxMenu
*m_menuDatagramSocket
;
98 wxMenu
*m_menuProtocols
;
102 // any class wishing to process wxWidgets events must use this macro
103 DECLARE_EVENT_TABLE()
106 // simple helper class to log start and end of each test
110 TestLogger(const wxString
& name
) : m_name(name
)
112 wxLogMessage("=== %s test begins ===", m_name
);
117 wxLogMessage("=== %s test ends ===", m_name
);
121 const wxString m_name
;
124 // --------------------------------------------------------------------------
126 // --------------------------------------------------------------------------
128 // IDs for the controls and the menu commands
132 CLIENT_QUIT
= wxID_EXIT
,
133 CLIENT_ABOUT
= wxID_ABOUT
,
151 // --------------------------------------------------------------------------
152 // event tables and other macros for wxWidgets
153 // --------------------------------------------------------------------------
155 BEGIN_EVENT_TABLE(MyFrame
, wxFrame
)
156 EVT_MENU(CLIENT_QUIT
, MyFrame::OnQuit
)
157 EVT_MENU(CLIENT_ABOUT
, MyFrame::OnAbout
)
158 EVT_MENU(CLIENT_OPEN
, MyFrame::OnOpenConnection
)
160 EVT_MENU(CLIENT_OPENIPV6
, MyFrame::OnOpenConnectionIPv6
)
162 EVT_MENU(CLIENT_TEST1
, MyFrame::OnTest1
)
163 EVT_MENU(CLIENT_TEST2
, MyFrame::OnTest2
)
164 EVT_MENU(CLIENT_TEST3
, MyFrame::OnTest3
)
165 EVT_MENU(CLIENT_CLOSE
, MyFrame::OnCloseConnection
)
166 EVT_MENU(CLIENT_DGRAM
, MyFrame::OnDatagram
)
168 EVT_MENU(CLIENT_TESTURL
, MyFrame::OnTestURL
)
170 EVT_SOCKET(SOCKET_ID
, MyFrame::OnSocketEvent
)
175 // ==========================================================================
177 // ==========================================================================
179 // --------------------------------------------------------------------------
180 // the application class
181 // --------------------------------------------------------------------------
185 if ( !wxApp::OnInit() )
188 // Create the main application window
189 MyFrame
*frame
= new MyFrame();
191 // Show it and tell the application that it's our main window
199 // --------------------------------------------------------------------------
201 // --------------------------------------------------------------------------
204 MyFrame::MyFrame() : wxFrame((wxFrame
*)NULL
, wxID_ANY
,
205 _("wxSocket demo: Client"),
206 wxDefaultPosition
, wxSize(300, 200))
208 // Give the frame an icon
209 SetIcon(wxICON(mondrian
));
212 m_menuFile
= new wxMenu();
213 m_menuFile
->Append(CLIENT_ABOUT
, _("&About...\tCtrl-A"), _("Show about dialog"));
214 m_menuFile
->AppendSeparator();
215 m_menuFile
->Append(CLIENT_QUIT
, _("E&xit\tAlt-X"), _("Quit client"));
217 m_menuSocket
= new wxMenu();
218 m_menuSocket
->Append(CLIENT_OPEN
, _("&Open session\tCtrl-O"), _("Connect to server"));
220 m_menuSocket
->Append(CLIENT_OPENIPV6
, _("&Open session(IPv6)\tShift-Ctrl-O"), _("Connect to server(IPv6)"));
222 m_menuSocket
->AppendSeparator();
223 m_menuSocket
->Append(CLIENT_TEST1
, _("Test &1\tCtrl-F1"), _("Test basic functionality"));
224 m_menuSocket
->Append(CLIENT_TEST2
, _("Test &2\tCtrl-F2"), _("Test ReadMsg and WriteMsg"));
225 m_menuSocket
->Append(CLIENT_TEST3
, _("Test &3\tCtrl-F3"), _("Test large data transfer"));
226 m_menuSocket
->AppendSeparator();
227 m_menuSocket
->Append(CLIENT_CLOSE
, _("&Close session\tCtrl-Q"), _("Close connection"));
229 m_menuDatagramSocket
= new wxMenu();
230 m_menuDatagramSocket
->Append(CLIENT_DGRAM
, _("Send Datagram"), _("Test UDP sockets"));
233 m_menuProtocols
= new wxMenu();
234 m_menuProtocols
->Append(CLIENT_TESTURL
, _("Test URL\tCtrl-U"),
235 _("Get data from the specified URL"));
238 // Append menus to the menubar
239 m_menuBar
= new wxMenuBar();
240 m_menuBar
->Append(m_menuFile
, _("&File"));
241 m_menuBar
->Append(m_menuSocket
, _("&SocketClient"));
242 m_menuBar
->Append(m_menuDatagramSocket
, _("&DatagramSocket"));
244 m_menuBar
->Append(m_menuProtocols
, _("&Protocols"));
246 SetMenuBar(m_menuBar
);
251 #endif // wxUSE_STATUSBAR
253 // Make a textctrl for logging
254 m_text
= new wxTextCtrl(this, wxID_ANY
,
255 _("Welcome to wxSocket demo: Client\nClient ready\n"),
256 wxDefaultPosition
, wxDefaultSize
,
257 wxTE_MULTILINE
| wxTE_READONLY
);
258 delete wxLog::SetActiveTarget(new wxLogTextCtrl(m_text
));
261 m_sock
= new wxSocketClient();
263 // Setup the event handler and subscribe to most events
264 m_sock
->SetEventHandler(*this, SOCKET_ID
);
265 m_sock
->SetNotify(wxSOCKET_CONNECTION_FLAG
|
266 wxSOCKET_INPUT_FLAG
|
268 m_sock
->Notify(true);
276 // No delayed deletion here, as the frame is dying anyway
282 void MyFrame::OnQuit(wxCommandEvent
& WXUNUSED(event
))
284 // true is to force the frame to close
288 void MyFrame::OnAbout(wxCommandEvent
& WXUNUSED(event
))
290 wxMessageBox(_("wxSocket demo: Client\n(c) 1999 Guillermo Rodriguez Garcia\n"),
292 wxOK
| wxICON_INFORMATION
, this);
295 void MyFrame::OnOpenConnection(wxCommandEvent
& WXUNUSED(event
))
297 OpenConnection(wxSockAddress::IPV4
);
300 void MyFrame::OnOpenConnectionIPv6(wxCommandEvent
& WXUNUSED(event
))
302 OpenConnection(wxSockAddress::IPV6
);
306 void MyFrame::OpenConnection(wxSockAddress::Family family
)
308 wxUnusedVar(family
); // unused in !wxUSE_IPV6 case
314 if ( family
== wxSockAddress::IPV6
)
320 m_menuSocket
->Enable(CLIENT_OPEN
, false);
322 m_menuSocket
->Enable(CLIENT_OPENIPV6
, false);
324 m_menuSocket
->Enable(CLIENT_CLOSE
, false);
326 // Ask user for server address
327 wxString hostname
= wxGetTextFromUser(
328 _("Enter the address of the wxSocket demo server:"),
332 addr
->Hostname(hostname
);
335 // Mini-tutorial for Connect() :-)
336 // ---------------------------
338 // There are two ways to use Connect(): blocking and non-blocking,
339 // depending on the value passed as the 'wait' (2nd) parameter.
341 // Connect(addr, true) will wait until the connection completes,
342 // returning true on success and false on failure. This call blocks
343 // the GUI (this might be changed in future releases to honour the
344 // wxSOCKET_BLOCK flag).
346 // Connect(addr, false) will issue a nonblocking connection request
347 // and return immediately. If the return value is true, then the
348 // connection has been already successfully established. If it is
349 // false, you must wait for the request to complete, either with
350 // WaitOnConnect() or by watching wxSOCKET_CONNECTION / LOST
351 // events (please read the documentation).
353 // WaitOnConnect() itself never blocks the GUI (this might change
354 // in the future to honour the wxSOCKET_BLOCK flag). This call will
355 // return false on timeout, or true if the connection request
356 // completes, which in turn might mean:
358 // a) That the connection was successfully established
359 // b) That the connection request failed (for example, because
360 // it was refused by the peer.
362 // Use IsConnected() to distinguish between these two.
364 // So, in a brief, you should do one of the following things:
366 // For blocking Connect:
368 // bool success = client->Connect(addr, true);
370 // For nonblocking Connect:
372 // client->Connect(addr, false);
374 // bool waitmore = true;
375 // while (! client->WaitOnConnect(seconds, millis) && waitmore )
377 // // possibly give some feedback to the user,
378 // // update waitmore if needed.
380 // bool success = client->IsConnected();
382 // And that's all :-)
384 m_text
->AppendText(_("\nTrying to connect (timeout = 10 sec) ...\n"));
385 m_sock
->Connect(*addr
, false);
386 m_sock
->WaitOnConnect(10);
388 if (m_sock
->IsConnected())
389 m_text
->AppendText(_("Succeeded ! Connection established\n"));
393 m_text
->AppendText(_("Failed ! Unable to connect\n"));
394 wxMessageBox(_("Can't connect to the specified host"), _("Alert !"));
400 void MyFrame::OnTest1(wxCommandEvent
& WXUNUSED(event
))
402 // Disable socket menu entries (exception: Close Session)
406 m_text
->AppendText(_("\n=== Test 1 begins ===\n"));
408 // Tell the server which test we are running
409 unsigned char c
= 0xBE;
410 m_sock
->Write(&c
, 1);
412 // Send some data and read it back. We know the size of the
413 // buffer, so we can specify the exact number of bytes to be
414 // sent or received and use the wxSOCKET_WAITALL flag. Also,
415 // we have disabled menu entries which could interfere with
416 // the test, so we can safely avoid the wxSOCKET_BLOCK flag.
418 // First we send a byte with the length of the string, then
419 // we send the string itself (do NOT try to send any integral
420 // value larger than a byte "as is" across the network, or
421 // you might be in trouble! Ever heard about big and little
422 // endian computers?)
424 m_sock
->SetFlags(wxSOCKET_WAITALL
);
426 const char *buf1
= "Test string (less than 256 chars!)";
427 unsigned char len
= (unsigned char)(wxStrlen(buf1
) + 1);
428 wxCharBuffer
buf2(wxStrlen(buf1
));
430 m_text
->AppendText(_("Sending a test buffer to the server ..."));
431 m_sock
->Write(&len
, 1);
432 m_sock
->Write(buf1
, len
);
433 m_text
->AppendText(m_sock
->Error() ? _("failed !\n") : _("done\n"));
435 m_text
->AppendText(_("Receiving the buffer back from server ..."));
436 m_sock
->Read(buf2
.data(), len
);
437 m_text
->AppendText(m_sock
->Error() ? _("failed !\n") : _("done\n"));
439 m_text
->AppendText(_("Comparing the two buffers ..."));
440 if (memcmp(buf1
, buf2
, len
) != 0)
442 m_text
->AppendText(_("failed!\n"));
443 m_text
->AppendText(_("Test 1 failed !\n"));
447 m_text
->AppendText(_("done\n"));
448 m_text
->AppendText(_("Test 1 passed !\n"));
450 m_text
->AppendText(_("=== Test 1 ends ===\n"));
456 void MyFrame::OnTest2(wxCommandEvent
& WXUNUSED(event
))
458 // Disable socket menu entries (exception: Close Session)
462 m_text
->AppendText(_("\n=== Test 2 begins ===\n"));
464 // Tell the server which test we are running
465 unsigned char c
= 0xCE;
466 m_sock
->Write(&c
, 1);
468 // Here we use ReadMsg and WriteMsg to send messages with
469 // a header with size information. Also, the reception is
470 // event triggered, so we test input events as well.
472 // We need to set no flags here (ReadMsg and WriteMsg are
473 // not affected by flags)
475 m_sock
->SetFlags(wxSOCKET_WAITALL
);
477 wxString s
= wxGetTextFromUser(
478 _("Enter an arbitrary string to send to the server:"),
480 _("Yes I like wxWidgets!"));
482 const wxScopedCharBuffer
msg1(s
.utf8_str());
483 size_t len
= wxStrlen(msg1
) + 1;
484 wxCharBuffer
msg2(wxStrlen(msg1
));
486 m_text
->AppendText(_("Sending the string with WriteMsg ..."));
487 m_sock
->WriteMsg(msg1
, len
);
488 m_text
->AppendText(m_sock
->Error() ? _("failed !\n") : _("done\n"));
489 m_text
->AppendText(_("Waiting for an event (timeout = 2 sec)\n"));
491 // Wait until data available (will also return if the connection is lost)
492 m_sock
->WaitForRead(2);
494 if (m_sock
->IsData())
496 m_text
->AppendText(_("Reading the string back with ReadMsg ..."));
497 m_sock
->ReadMsg(msg2
.data(), len
);
498 m_text
->AppendText(m_sock
->Error() ? _("failed !\n") : _("done\n"));
499 m_text
->AppendText(_("Comparing the two buffers ..."));
500 if (memcmp(msg1
, msg2
, len
) != 0)
502 m_text
->AppendText(_("failed!\n"));
503 m_text
->AppendText(_("Test 2 failed !\n"));
507 m_text
->AppendText(_("done\n"));
508 m_text
->AppendText(_("Test 2 passed !\n"));
512 m_text
->AppendText(_("Timeout ! Test 2 failed.\n"));
514 m_text
->AppendText(_("=== Test 2 ends ===\n"));
520 void MyFrame::OnTest3(wxCommandEvent
& WXUNUSED(event
))
522 // Disable socket menu entries (exception: Close Session)
526 m_text
->AppendText(_("\n=== Test 3 begins ===\n"));
528 // Tell the server which test we are running
529 unsigned char c
= 0xDE;
530 m_sock
->Write(&c
, 1);
532 // This test also is similar to the first one but it sends a
533 // large buffer so that wxSocket is actually forced to split
534 // it into pieces and take care of sending everything before
537 m_sock
->SetFlags(wxSOCKET_WAITALL
);
539 // Note that len is in kbytes here!
540 const unsigned char len
= 32;
541 wxCharBuffer
buf1(len
* 1024),
544 for (size_t i
= 0; i
< len
* 1024; i
++)
545 buf1
.data()[i
] = (char)(i
% 256);
547 m_text
->AppendText(_("Sending a large buffer (32K) to the server ..."));
548 m_sock
->Write(&len
, 1);
549 m_sock
->Write(buf1
, len
* 1024);
550 m_text
->AppendText(m_sock
->Error() ? _("failed !\n") : _("done\n"));
552 m_text
->AppendText(_("Receiving the buffer back from server ..."));
553 m_sock
->Read(buf2
.data(), len
* 1024);
554 m_text
->AppendText(m_sock
->Error() ? _("failed !\n") : _("done\n"));
556 m_text
->AppendText(_("Comparing the two buffers ..."));
557 if (memcmp(buf1
, buf2
, len
) != 0)
559 m_text
->AppendText(_("failed!\n"));
560 m_text
->AppendText(_("Test 3 failed !\n"));
564 m_text
->AppendText(_("done\n"));
565 m_text
->AppendText(_("Test 3 passed !\n"));
567 m_text
->AppendText(_("=== Test 3 ends ===\n"));
573 void MyFrame::OnCloseConnection(wxCommandEvent
& WXUNUSED(event
))
579 void MyFrame::OnDatagram(wxCommandEvent
& WXUNUSED(event
))
581 m_text
->AppendText(_("\n=== Datagram test begins ===\n"));
582 m_text
->AppendText(_("Sorry, not implemented\n"));
583 m_text
->AppendText(_("=== Datagram test ends ===\n"));
588 void MyFrame::OnTestURL(wxCommandEvent
& WXUNUSED(event
))
591 static wxString
s_urlname("http://www.google.com/");
592 wxString urlname
= wxGetTextFromUser
594 _("Enter an URL to get"),
598 if ( urlname
.empty() )
599 return; // cancelled by user
604 TestLogger
logtest("URL");
608 if ( url
.GetError() != wxURL_NOERR
)
610 wxLogError("Failed to parse URL \"%s\"", urlname
);
614 // Try to get the input stream (connects to the given URL)
615 wxLogMessage("Establishing connection to \"%s\"...", urlname
);
616 const std::auto_ptr
<wxInputStream
> data(url
.GetInputStream());
619 wxLogError("Failed to retrieve URL \"%s\"", urlname
);
623 // Print the contents type and file size
624 wxLogMessage("Contents type: %s\nFile size: %i\nStarting to download...",
625 url
.GetProtocol().GetContentType(),
629 wxStringOutputStream sout
;
630 if ( data
->Read(sout
).GetLastError() != wxSTREAM_EOF
)
631 wxLogError("Error reading the input stream.");
633 wxLogMessage("Text retrieved from URL \"%s\" follows:\n%s",
634 urlname
, sout
.GetString());
639 void MyFrame::OnSocketEvent(wxSocketEvent
& event
)
641 wxString s
= _("OnSocketEvent: ");
643 switch(event
.GetSocketEvent())
645 case wxSOCKET_INPUT
: s
.Append(_("wxSOCKET_INPUT\n")); break;
646 case wxSOCKET_LOST
: s
.Append(_("wxSOCKET_LOST\n")); break;
647 case wxSOCKET_CONNECTION
: s
.Append(_("wxSOCKET_CONNECTION\n")); break;
648 default : s
.Append(_("Unexpected event !\n")); break;
651 m_text
->AppendText(s
);
655 // convenience functions
657 void MyFrame::UpdateStatusBar()
661 if (!m_sock
->IsConnected())
663 s
.Printf(_("Not connected"));
673 m_sock
->GetPeer(addr
);
674 s
.Printf(_("%s : %d"), (addr
.Hostname()).c_str(), addr
.Service());
679 #endif // wxUSE_STATUSBAR
681 m_menuSocket
->Enable(CLIENT_OPEN
, !m_sock
->IsConnected() && !m_busy
);
683 m_menuSocket
->Enable(CLIENT_OPENIPV6
, !m_sock
->IsConnected() && !m_busy
);
685 m_menuSocket
->Enable(CLIENT_TEST1
, m_sock
->IsConnected() && !m_busy
);
686 m_menuSocket
->Enable(CLIENT_TEST2
, m_sock
->IsConnected() && !m_busy
);
687 m_menuSocket
->Enable(CLIENT_TEST3
, m_sock
->IsConnected() && !m_busy
);
688 m_menuSocket
->Enable(CLIENT_CLOSE
, m_sock
->IsConnected());