wxWidgets: wxIPV4address Class Reference

| Version: 3.0.2

- Main Page
- Related Pages
- Categories
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | List of all members
wxIPV4address Class Reference
Networking

`#include <wx/socket.h>`

Inheritance diagram for wxIPV4address:
[legend]

## Detailed Description

A class for working with IPv4 network addresses.

##

Library: wxNet
Category: Networking

## Public Member Functions
bool | AnyAddress ()
| Set address to any of the addresses of the current machine.
bool | Hostname (const wxString &hostname)
| Set the address to hostname, which can be a host name or an IP-style address in dot notation(`a.b.c.d`).
virtual wxString | Hostname () const
| Returns the hostname which matches the IP address.
virtual wxString | IPAddress () const
| Returns a wxString containing the IP address in dot quad (127.0.0.1) format.
bool | LocalHost ()
| Set address to localhost (127.0.0.1).
bool | Service (const wxString &service)
| Set the port to that corresponding to the specified service.
bool | Service (unsigned short service)
| Set the port to that corresponding to the specified service.
unsigned short | Service () const
| Returns the current service.
Public Member Functions inherited from wxIPaddress
bool | AnyAddress ()
| Internally, this is the same as setting the IP address to INADDR_ANY.
virtual bool | BroadcastAddress ()=0
| Internally, this is the same as setting the IP address to INADDR_BROADCAST.
bool | Hostname (const wxString &hostname)
| Set the address to hostname, which can be a host name or an IP-style address in a format dependent on implementation.
wxString | Hostname () const
| Returns the hostname which matches the IP address.
virtual bool | IsLocalHost () const =0
| Determines if current address is set to localhost.
bool | LocalHost ()
| Set address to localhost.
bool | Service (const wxString &service)
| Set the port to that corresponding to the specified service.
bool | Service (unsigned short service)
| Set the port to that corresponding to the specified service.
unsigned short | Service () const
| Returns the current service.
Public Member Functions inherited from wxSockAddress
| wxSockAddress ()
| Default constructor.
virtual | ~wxSockAddress ()
| Default destructor.
virtual void | Clear ()
| Delete all information about the address.
int | SockAddrLen ()
| Returns the length of the socket address.
const sockaddr * | GetAddressData () const
| Returns the pointer to the low-level representation of the address.
int | GetAddressDataLen () const
| Returns the length of the buffer retrieved by GetAddressData().
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data.
| wxObject (const wxObject &other)
| Copy ctor.
virtual | ~wxObject ()
| Destructor.
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class.
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj.
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone.
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer.
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data.
void | UnShare ()
| This is the same of AllocExclusive() but this method is public.
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

## Additional Inherited Members
Protected Member Functions inherited from wxObject
void | AllocExclusive ()
| Ensure that this object's data is not shared with any other object.
virtual wxObjectRefData * | CreateRefData () const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.
Protected Attributes inherited from wxObject
wxObjectRefData * | m_refData
| Pointer to an object which is the object's reference-counted data.

## Member Function Documentation

bool wxIPV4address::AnyAddress | ( |  | ) |

Set address to any of the addresses of the current machine.

Whenever possible, use this function instead of LocalHost(), as this correctly handles multi-homed hosts and avoids other small problems. Internally, this is the same as setting the IP address to INADDR_ANY.

Returns
  true on success, false if something went wrong.

bool wxIPV4address::Hostname | ( | const wxString & | hostname | ) |

Set the address to hostname, which can be a host name or an IP-style address in dot notation(`a.b.c.d`).

Returns
  true on success, false if something goes wrong (invalid hostname or invalid IP address).

virtual wxString wxIPV4address::Hostname | ( |  | ) | const
| virtual

Returns the hostname which matches the IP address.

virtual wxString wxIPV4address::IPAddress | ( |  | ) | const
| virtual

Returns a wxString containing the IP address in dot quad (127.0.0.1) format.

Implements wxIPaddress.

bool wxIPV4address::LocalHost | ( |  | ) |

Set address to localhost (127.0.0.1).

Whenever possible, use AnyAddress() instead of this one, as that one will correctly handle multi-homed hosts and avoid other small problems.

Returns
  true on success, false if something went wrong.

bool wxIPV4address::Service | ( | const wxString & | service | ) |

Set the port to that corresponding to the specified service.

Returns
  true on success, false if something goes wrong (invalid service).

bool wxIPV4address::Service | ( | unsigned short | service | ) |

Set the port to that corresponding to the specified service.

Returns
  true on success, false if something goes wrong (invalid service).

unsigned short wxIPV4address::Service | ( |  | ) | const

Returns the current service.