#include <BaseUDP.h>
◆ ~BaseUDP()
virtual ehs::BaseUDP::~BaseUDP |
( |
| ) |
|
|
virtualdefault |
◆ BaseUDP() [1/4]
ehs::BaseUDP::BaseUDP |
( |
| ) |
|
Initializes the socket with the defaults.
◆ BaseUDP() [2/4]
ehs::BaseUDP::BaseUDP |
( |
IP | version | ) |
|
Properly initializes the socket.
- Parameters
-
[in] | type | The ip version to initialize the socket with. |
◆ BaseUDP() [3/4]
ehs::BaseUDP::BaseUDP |
( |
BaseUDP && | udp | ) |
|
|
noexcept |
◆ BaseUDP() [4/4]
ehs::BaseUDP::BaseUDP |
( |
const BaseUDP & | udp | ) |
|
◆ Bind()
virtual void ehs::BaseUDP::Bind |
( |
const Endpoint & | endpoint | ) |
|
|
pure virtual |
Binds to socket to a specified address and port.
- Parameters
-
[in] | type | The ip version to use. |
[in] | address | The ip address to bind to. |
[in] | port | The port to bind to. |
- Note
- Used for servers.
Implemented in ehs::UDP, and ehs::UDP.
◆ GetLocalEndpoint()
Endpoint ehs::BaseUDP::GetLocalEndpoint |
( |
| ) |
const |
◆ IsBlocking()
virtual bool ehs::BaseUDP::IsBlocking |
( |
| ) |
const |
|
pure virtual |
Retrieves whether or not when receiving data blocks the thread.
- Returns
- The result.
Implemented in ehs::UDP, and ehs::UDP.
◆ IsBound()
bool ehs::BaseUDP::IsBound |
( |
| ) |
const |
Retrieves whether or not this socket is bound to an ip address and port.
- Returns
- The result.
◆ IsIPv6Only()
virtual bool ehs::BaseUDP::IsIPv6Only |
( |
| ) |
const |
|
pure virtual |
◆ IsValid()
virtual bool ehs::BaseUDP::IsValid |
( |
| ) |
const |
|
pure virtual |
Retrieves whether or not this socket was initialized.
- Returns
- The result.
Implemented in ehs::UDP, and ehs::UDP.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ Receive()
virtual UInt_64 ehs::BaseUDP::Receive |
( |
Endpoint * | endpoint, |
|
|
Byte * | data, |
|
|
UInt_64 | size ) |
|
pure virtual |
Receives data from the endpoint.
- Parameters
-
[out] | type | The ip version of the endpoint. |
[out] | address | The ip address of the endpoint. |
[out] | port | The port of the endpoint. |
[out] | data | The incoming data from the endpoint. |
[in] | size | The max size of the buffer in bytes to store the data. |
- Returns
- The size of the incoming data in bytes.
Implemented in ehs::UDP, and ehs::UDP.
◆ Release()
virtual void ehs::BaseUDP::Release |
( |
| ) |
|
|
pure virtual |
Explicitly release resources before it falls off the stack.
Implemented in ehs::UDP, and ehs::UDP.
◆ Send()
virtual UInt_64 ehs::BaseUDP::Send |
( |
const Endpoint & | endpoint, |
|
|
const Byte * | data, |
|
|
UInt_64 | size ) |
|
pure virtual |
Sends data to the endpoint.
- Parameters
-
[in] | type | The ip version of the endpoint. |
[in] | address | The ip address of the endpoint. |
[in] | port | The port of the endpoint is bound to. |
Implemented in ehs::UDP, and ehs::UDP.
◆ SetBlocking()
virtual void ehs::BaseUDP::SetBlocking |
( |
bool | blocking | ) |
|
|
pure virtual |
Sets whether or not the socket blocks the thread when receiving data.
- Parameters
-
[in] | blocking | Whether or not to block. |
Implemented in ehs::UDP, and ehs::UDP.
◆ SetIPv6Only()
virtual void ehs::BaseUDP::SetIPv6Only |
( |
bool | value | ) |
|
|
pure virtual |
◆ bound
◆ localEndpoint
The documentation for this class was generated from the following files: