Document domain parameter of wxTranslations::GetTranslatedString().
[wxWidgets.git] / samples / sockets / client.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: client.cpp
3 // Purpose: Client for wxSocket demo
4 // Author: Guillermo Rodriguez Garcia <guille@iies.es>
5 // Modified by:
6 // Created: 1999/09/19
7 // Copyright: (c) 1999 Guillermo Rodriguez Garcia
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 // ==========================================================================
12 // declarations
13 // ==========================================================================
14
15 // --------------------------------------------------------------------------
16 // headers
17 // --------------------------------------------------------------------------
18
19 // For compilers that support precompilation, includes "wx/wx.h".
20 #include "wx/wxprec.h"
21
22 #ifdef __BORLANDC__
23 # pragma hdrstop
24 #endif
25
26 // for all others, include the necessary headers
27 #ifndef WX_PRECOMP
28 # include "wx/wx.h"
29 #endif
30
31 #include "wx/socket.h"
32 #include "wx/url.h"
33 #include "wx/sstream.h"
34 #include <memory>
35
36 // --------------------------------------------------------------------------
37 // resources
38 // --------------------------------------------------------------------------
39
40 // the application icon
41 #ifndef wxHAS_IMAGES_IN_RESOURCES
42 #include "../sample.xpm"
43 #endif
44
45 // --------------------------------------------------------------------------
46 // classes
47 // --------------------------------------------------------------------------
48
49 // Define a new application type
50 class MyApp : public wxApp
51 {
52 public:
53 virtual bool OnInit();
54 };
55
56 // Define a new frame type: this is going to be our main frame
57 class MyFrame : public wxFrame
58 {
59 public:
60 MyFrame();
61 ~MyFrame();
62
63 // event handlers for File menu
64 void OnQuit(wxCommandEvent& event);
65 void OnAbout(wxCommandEvent& event);
66
67 // event handlers for Socket menu
68 void OnOpenConnection(wxCommandEvent& event);
69 void OnTest1(wxCommandEvent& event);
70 void OnTest2(wxCommandEvent& event);
71 void OnTest3(wxCommandEvent& event);
72 void OnCloseConnection(wxCommandEvent& event);
73
74 #if wxUSE_URL
75 // event handlers for Protocols menu
76 void OnTestURL(wxCommandEvent& event);
77 #endif
78 #if wxUSE_IPV6
79 void OnOpenConnectionIPv6(wxCommandEvent& event);
80 #endif
81
82 void OpenConnection(wxSockAddress::Family family);
83
84 // event handlers for DatagramSocket menu (stub)
85 void OnDatagram(wxCommandEvent& event);
86
87 // socket event handler
88 void OnSocketEvent(wxSocketEvent& event);
89
90 // convenience functions
91 void UpdateStatusBar();
92
93 private:
94 wxSocketClient *m_sock;
95 wxTextCtrl *m_text;
96 wxMenu *m_menuFile;
97 wxMenu *m_menuSocket;
98 wxMenu *m_menuDatagramSocket;
99 wxMenu *m_menuProtocols;
100 wxMenuBar *m_menuBar;
101 bool m_busy;
102
103 // any class wishing to process wxWidgets events must use this macro
104 DECLARE_EVENT_TABLE()
105 };
106
107 // simple helper class to log start and end of each test
108 class TestLogger
109 {
110 public:
111 TestLogger(const wxString& name) : m_name(name)
112 {
113 wxLogMessage("=== %s test begins ===", m_name);
114 }
115
116 ~TestLogger()
117 {
118 wxLogMessage("=== %s test ends ===", m_name);
119 }
120
121 private:
122 const wxString m_name;
123 };
124
125 // --------------------------------------------------------------------------
126 // constants
127 // --------------------------------------------------------------------------
128
129 // IDs for the controls and the menu commands
130 enum
131 {
132 // menu items
133 CLIENT_QUIT = wxID_EXIT,
134 CLIENT_ABOUT = wxID_ABOUT,
135 CLIENT_OPEN = 100,
136 #if wxUSE_IPV6
137 CLIENT_OPENIPV6,
138 #endif
139 CLIENT_TEST1,
140 CLIENT_TEST2,
141 CLIENT_TEST3,
142 CLIENT_CLOSE,
143 #if wxUSE_URL
144 CLIENT_TESTURL,
145 #endif
146 CLIENT_DGRAM,
147
148 // id for socket
149 SOCKET_ID
150 };
151
152 // --------------------------------------------------------------------------
153 // event tables and other macros for wxWidgets
154 // --------------------------------------------------------------------------
155
156 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
157 EVT_MENU(CLIENT_QUIT, MyFrame::OnQuit)
158 EVT_MENU(CLIENT_ABOUT, MyFrame::OnAbout)
159 EVT_MENU(CLIENT_OPEN, MyFrame::OnOpenConnection)
160 #if wxUSE_IPV6
161 EVT_MENU(CLIENT_OPENIPV6, MyFrame::OnOpenConnectionIPv6)
162 #endif
163 EVT_MENU(CLIENT_TEST1, MyFrame::OnTest1)
164 EVT_MENU(CLIENT_TEST2, MyFrame::OnTest2)
165 EVT_MENU(CLIENT_TEST3, MyFrame::OnTest3)
166 EVT_MENU(CLIENT_CLOSE, MyFrame::OnCloseConnection)
167 EVT_MENU(CLIENT_DGRAM, MyFrame::OnDatagram)
168 #if wxUSE_URL
169 EVT_MENU(CLIENT_TESTURL, MyFrame::OnTestURL)
170 #endif
171 EVT_SOCKET(SOCKET_ID, MyFrame::OnSocketEvent)
172 END_EVENT_TABLE()
173
174 IMPLEMENT_APP(MyApp)
175
176 // ==========================================================================
177 // implementation
178 // ==========================================================================
179
180 // --------------------------------------------------------------------------
181 // the application class
182 // --------------------------------------------------------------------------
183
184 bool MyApp::OnInit()
185 {
186 if ( !wxApp::OnInit() )
187 return false;
188
189 // Create the main application window
190 MyFrame *frame = new MyFrame();
191
192 // Show it
193 frame->Show(true);
194
195 // success
196 return true;
197 }
198
199 // --------------------------------------------------------------------------
200 // main frame
201 // --------------------------------------------------------------------------
202
203 // frame constructor
204 MyFrame::MyFrame() : wxFrame((wxFrame *)NULL, wxID_ANY,
205 _("wxSocket demo: Client"),
206 wxDefaultPosition, wxSize(300, 200))
207 {
208 // Give the frame an icon
209 SetIcon(wxICON(sample));
210
211 // Make menus
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"));
216
217 m_menuSocket = new wxMenu();
218 m_menuSocket->Append(CLIENT_OPEN, _("&Open session\tCtrl-O"), _("Connect to server"));
219 #if wxUSE_IPV6
220 m_menuSocket->Append(CLIENT_OPENIPV6, _("&Open session(IPv6)\tShift-Ctrl-O"), _("Connect to server(IPv6)"));
221 #endif
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"));
228
229 m_menuDatagramSocket = new wxMenu();
230 m_menuDatagramSocket->Append(CLIENT_DGRAM, _("&Datagram test\tCtrl-D"), _("Test UDP sockets"));
231
232 #if wxUSE_URL
233 m_menuProtocols = new wxMenu();
234 m_menuProtocols->Append(CLIENT_TESTURL, _("Test URL\tCtrl-U"),
235 _("Get data from the specified URL"));
236 #endif
237
238 // Append menus to the menubar
239 m_menuBar = new wxMenuBar();
240 m_menuBar->Append(m_menuFile, _("&File"));
241 m_menuBar->Append(m_menuSocket, _("&TCP"));
242 m_menuBar->Append(m_menuDatagramSocket, _("&UDP"));
243 #if wxUSE_URL
244 m_menuBar->Append(m_menuProtocols, _("&Protocols"));
245 #endif
246 SetMenuBar(m_menuBar);
247
248 #if wxUSE_STATUSBAR
249 // Status bar
250 CreateStatusBar(2);
251 #endif // wxUSE_STATUSBAR
252
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));
259
260 // Create the socket
261 m_sock = new wxSocketClient();
262
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 |
267 wxSOCKET_LOST_FLAG);
268 m_sock->Notify(true);
269
270 m_busy = false;
271 UpdateStatusBar();
272 }
273
274 MyFrame::~MyFrame()
275 {
276 // No delayed deletion here, as the frame is dying anyway
277 delete m_sock;
278 }
279
280 // event handlers
281
282 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
283 {
284 // true is to force the frame to close
285 Close(true);
286 }
287
288 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
289 {
290 wxMessageBox(_("wxSocket demo: Client\n(c) 1999 Guillermo Rodriguez Garcia\n"),
291 _("About Client"),
292 wxOK | wxICON_INFORMATION, this);
293 }
294
295 void MyFrame::OnOpenConnection(wxCommandEvent& WXUNUSED(event))
296 {
297 OpenConnection(wxSockAddress::IPV4);
298 }
299 #if wxUSE_IPV6
300 void MyFrame::OnOpenConnectionIPv6(wxCommandEvent& WXUNUSED(event))
301 {
302 OpenConnection(wxSockAddress::IPV6);
303 }
304 #endif // wxUSE_IPV6
305
306 void MyFrame::OpenConnection(wxSockAddress::Family family)
307 {
308 wxUnusedVar(family); // unused in !wxUSE_IPV6 case
309
310 wxIPaddress * addr;
311 wxIPV4address addr4;
312 #if wxUSE_IPV6
313 wxIPV6address addr6;
314 if ( family == wxSockAddress::IPV6 )
315 addr = &addr6;
316 else
317 #endif
318 addr = &addr4;
319
320 m_menuSocket->Enable(CLIENT_OPEN, false);
321 #if wxUSE_IPV6
322 m_menuSocket->Enable(CLIENT_OPENIPV6, false);
323 #endif
324 m_menuSocket->Enable(CLIENT_CLOSE, false);
325
326 // Ask user for server address
327 wxString hostname = wxGetTextFromUser(
328 _("Enter the address of the wxSocket demo server:"),
329 _("Connect ..."),
330 _("localhost"));
331 if ( hostname.empty() )
332 return;
333
334 addr->Hostname(hostname);
335 addr->Service(3000);
336
337 // we connect asynchronously and will get a wxSOCKET_CONNECTION event when
338 // the connection is really established
339 //
340 // if you want to make sure that connection is established right here you
341 // could call WaitOnConnect(timeout) instead
342 wxLogMessage("Trying to connect to %s:%d", hostname, addr->Service());
343
344 m_sock->Connect(*addr, false);
345 }
346
347 void MyFrame::OnTest1(wxCommandEvent& WXUNUSED(event))
348 {
349 // Disable socket menu entries (exception: Close Session)
350 m_busy = true;
351 UpdateStatusBar();
352
353 m_text->AppendText(_("\n=== Test 1 begins ===\n"));
354
355 // Tell the server which test we are running
356 unsigned char c = 0xBE;
357 m_sock->Write(&c, 1);
358
359 // Send some data and read it back. We know the size of the
360 // buffer, so we can specify the exact number of bytes to be
361 // sent or received and use the wxSOCKET_WAITALL flag. Also,
362 // we have disabled menu entries which could interfere with
363 // the test, so we can safely avoid the wxSOCKET_BLOCK flag.
364 //
365 // First we send a byte with the length of the string, then
366 // we send the string itself (do NOT try to send any integral
367 // value larger than a byte "as is" across the network, or
368 // you might be in trouble! Ever heard about big and little
369 // endian computers?)
370
371 m_sock->SetFlags(wxSOCKET_WAITALL);
372
373 const char *buf1 = "Test string (less than 256 chars!)";
374 unsigned char len = (unsigned char)(wxStrlen(buf1) + 1);
375 wxCharBuffer buf2(wxStrlen(buf1));
376
377 m_text->AppendText(_("Sending a test buffer to the server ..."));
378 m_sock->Write(&len, 1);
379 m_sock->Write(buf1, len);
380 m_text->AppendText(m_sock->Error() ? _("failed !\n") : _("done\n"));
381
382 m_text->AppendText(_("Receiving the buffer back from server ..."));
383 m_sock->Read(buf2.data(), len);
384 m_text->AppendText(m_sock->Error() ? _("failed !\n") : _("done\n"));
385
386 m_text->AppendText(_("Comparing the two buffers ..."));
387 if (memcmp(buf1, buf2, len) != 0)
388 {
389 m_text->AppendText(_("failed!\n"));
390 m_text->AppendText(_("Test 1 failed !\n"));
391 }
392 else
393 {
394 m_text->AppendText(_("done\n"));
395 m_text->AppendText(_("Test 1 passed !\n"));
396 }
397 m_text->AppendText(_("=== Test 1 ends ===\n"));
398
399 m_busy = false;
400 UpdateStatusBar();
401 }
402
403 void MyFrame::OnTest2(wxCommandEvent& WXUNUSED(event))
404 {
405 // Disable socket menu entries (exception: Close Session)
406 m_busy = true;
407 UpdateStatusBar();
408
409 m_text->AppendText(_("\n=== Test 2 begins ===\n"));
410
411 // Tell the server which test we are running
412 unsigned char c = 0xCE;
413 m_sock->Write(&c, 1);
414
415 // Here we use ReadMsg and WriteMsg to send messages with
416 // a header with size information. Also, the reception is
417 // event triggered, so we test input events as well.
418 //
419 // We need to set no flags here (ReadMsg and WriteMsg are
420 // not affected by flags)
421
422 m_sock->SetFlags(wxSOCKET_WAITALL);
423
424 wxString s = wxGetTextFromUser(
425 _("Enter an arbitrary string to send to the server:"),
426 _("Test 2 ..."),
427 _("Yes I like wxWidgets!"));
428
429 const wxScopedCharBuffer msg1(s.utf8_str());
430 size_t len = wxStrlen(msg1) + 1;
431 wxCharBuffer msg2(wxStrlen(msg1));
432
433 m_text->AppendText(_("Sending the string with WriteMsg ..."));
434 m_sock->WriteMsg(msg1, len);
435 m_text->AppendText(m_sock->Error() ? _("failed !\n") : _("done\n"));
436 m_text->AppendText(_("Waiting for an event (timeout = 2 sec)\n"));
437
438 // Wait until data available (will also return if the connection is lost)
439 m_sock->WaitForRead(2);
440
441 if (m_sock->IsData())
442 {
443 m_text->AppendText(_("Reading the string back with ReadMsg ..."));
444 m_sock->ReadMsg(msg2.data(), len);
445 m_text->AppendText(m_sock->Error() ? _("failed !\n") : _("done\n"));
446 m_text->AppendText(_("Comparing the two buffers ..."));
447 if (memcmp(msg1, msg2, len) != 0)
448 {
449 m_text->AppendText(_("failed!\n"));
450 m_text->AppendText(_("Test 2 failed !\n"));
451 }
452 else
453 {
454 m_text->AppendText(_("done\n"));
455 m_text->AppendText(_("Test 2 passed !\n"));
456 }
457 }
458 else
459 m_text->AppendText(_("Timeout ! Test 2 failed.\n"));
460
461 m_text->AppendText(_("=== Test 2 ends ===\n"));
462
463 m_busy = false;
464 UpdateStatusBar();
465 }
466
467 void MyFrame::OnTest3(wxCommandEvent& WXUNUSED(event))
468 {
469 // Disable socket menu entries (exception: Close Session)
470 m_busy = true;
471 UpdateStatusBar();
472
473 m_text->AppendText(_("\n=== Test 3 begins ===\n"));
474
475 // Tell the server which test we are running
476 unsigned char c = 0xDE;
477 m_sock->Write(&c, 1);
478
479 // This test also is similar to the first one but it sends a
480 // large buffer so that wxSocket is actually forced to split
481 // it into pieces and take care of sending everything before
482 // returning.
483
484 m_sock->SetFlags(wxSOCKET_WAITALL);
485
486 // Note that len is in kbytes here!
487 const unsigned char len = 32;
488 wxCharBuffer buf1(len * 1024),
489 buf2(len * 1024);
490
491 for (size_t i = 0; i < len * 1024; i ++)
492 buf1.data()[i] = (char)(i % 256);
493
494 m_text->AppendText(_("Sending a large buffer (32K) to the server ..."));
495 m_sock->Write(&len, 1);
496 m_sock->Write(buf1, len * 1024);
497 m_text->AppendText(m_sock->Error() ? _("failed !\n") : _("done\n"));
498
499 m_text->AppendText(_("Receiving the buffer back from server ..."));
500 m_sock->Read(buf2.data(), len * 1024);
501 m_text->AppendText(m_sock->Error() ? _("failed !\n") : _("done\n"));
502
503 m_text->AppendText(_("Comparing the two buffers ..."));
504 if (memcmp(buf1, buf2, len) != 0)
505 {
506 m_text->AppendText(_("failed!\n"));
507 m_text->AppendText(_("Test 3 failed !\n"));
508 }
509 else
510 {
511 m_text->AppendText(_("done\n"));
512 m_text->AppendText(_("Test 3 passed !\n"));
513 }
514 m_text->AppendText(_("=== Test 3 ends ===\n"));
515
516 m_busy = false;
517 UpdateStatusBar();
518 }
519
520 void MyFrame::OnCloseConnection(wxCommandEvent& WXUNUSED(event))
521 {
522 m_sock->Close();
523 UpdateStatusBar();
524 }
525
526 void MyFrame::OnDatagram(wxCommandEvent& WXUNUSED(event))
527 {
528 wxString hostname = wxGetTextFromUser
529 (
530 "Enter the address of the wxSocket demo server:",
531 "UDP peer",
532 "localhost"
533 );
534 if ( hostname.empty() )
535 return;
536
537 TestLogger logtest("UDP");
538
539 wxIPV4address addrLocal;
540 addrLocal.Hostname();
541 wxDatagramSocket sock(addrLocal);
542 if ( !sock.IsOk() )
543 {
544 wxLogMessage("ERROR: failed to create UDP socket");
545 return;
546 }
547
548 wxLogMessage("Created UDP socket at %s:%u",
549 addrLocal.IPAddress(), addrLocal.Service());
550
551 wxIPV4address addrPeer;
552 addrPeer.Hostname(hostname);
553 addrPeer.Service(3000);
554
555 wxLogMessage("Testing UDP with peer at %s:%u",
556 addrPeer.IPAddress(), addrPeer.Service());
557
558 char buf[] = "Uryyb sebz pyvrag!";
559 if ( sock.SendTo(addrPeer, buf, sizeof(buf)).LastCount() != sizeof(buf) )
560 {
561 wxLogMessage("ERROR: failed to send data");
562 return;
563 }
564
565 if ( sock.RecvFrom(addrPeer, buf, sizeof(buf)).LastCount() != sizeof(buf) )
566 {
567 wxLogMessage("ERROR: failed to receive data");
568 return;
569 }
570
571 wxLogMessage("Received \"%s\" from %s:%u.",
572 wxString::From8BitData(buf, sock.LastCount()),
573 addrPeer.IPAddress(), addrPeer.Service());
574 }
575
576 #if wxUSE_URL
577
578 void MyFrame::OnTestURL(wxCommandEvent& WXUNUSED(event))
579 {
580 // Ask for the URL
581 static wxString s_urlname("http://www.google.com/");
582 wxString urlname = wxGetTextFromUser
583 (
584 _("Enter an URL to get"),
585 _("URL:"),
586 s_urlname
587 );
588 if ( urlname.empty() )
589 return; // cancelled by user
590
591 s_urlname = urlname;
592
593
594 TestLogger logtest("URL");
595
596 // Parse the URL
597 wxURL url(urlname);
598 if ( url.GetError() != wxURL_NOERR )
599 {
600 wxLogError("Failed to parse URL \"%s\"", urlname);
601 return;
602 }
603
604 // Try to get the input stream (connects to the given URL)
605 wxLogMessage("Establishing connection to \"%s\"...", urlname);
606 const std::auto_ptr<wxInputStream> data(url.GetInputStream());
607 if ( !data.get() )
608 {
609 wxLogError("Failed to retrieve URL \"%s\"", urlname);
610 return;
611 }
612
613 // Print the contents type and file size
614 wxLogMessage("Contents type: %s\nFile size: %lu\nStarting to download...",
615 url.GetProtocol().GetContentType(),
616 static_cast<unsigned long>( data->GetSize() ));
617
618 // Get the data
619 wxStringOutputStream sout;
620 if ( data->Read(sout).GetLastError() != wxSTREAM_EOF )
621 {
622 wxLogError("Error reading the input stream.");
623 }
624
625 wxLogMessage("Text retrieved from URL \"%s\" follows:\n%s",
626 urlname, sout.GetString());
627 }
628
629 #endif // wxUSE_URL
630
631 void MyFrame::OnSocketEvent(wxSocketEvent& event)
632 {
633 switch ( event.GetSocketEvent() )
634 {
635 case wxSOCKET_INPUT:
636 wxLogMessage("Input available on the socket");
637 break;
638
639 case wxSOCKET_LOST:
640 wxLogMessage("Socket connection was unexpectedly lost.");
641 UpdateStatusBar();
642 break;
643
644 case wxSOCKET_CONNECTION:
645 wxLogMessage("... socket is now connected.");
646 UpdateStatusBar();
647 break;
648
649 default:
650 wxLogMessage("Unknown socket event!!!");
651 break;
652 }
653 }
654
655 // convenience functions
656
657 void MyFrame::UpdateStatusBar()
658 {
659 #if wxUSE_STATUSBAR
660 wxString s;
661
662 if (!m_sock->IsConnected())
663 {
664 s = "Not connected";
665 }
666 else
667 {
668 #if wxUSE_IPV6
669 wxIPV6address addr;
670 #else
671 wxIPV4address addr;
672 #endif
673
674 m_sock->GetPeer(addr);
675 s.Printf("%s : %d", addr.Hostname(), addr.Service());
676 }
677
678 SetStatusText(s, 1);
679 #endif // wxUSE_STATUSBAR
680
681 m_menuSocket->Enable(CLIENT_OPEN, !m_sock->IsConnected() && !m_busy);
682 #if wxUSE_IPV6
683 m_menuSocket->Enable(CLIENT_OPENIPV6, !m_sock->IsConnected() && !m_busy);
684 #endif
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());
689 }