mbed socket API

Dependents:   EthernetInterface EthernetInterface_RSF EthernetInterface EthernetInterface ... more

Embed: (wiki syntax)

« Back to documentation index

Endpoint Class Reference

Endpoint Class Reference

IP Endpoint (address, port) More...

#include <Endpoint.h>

Inherited by TCPSocketConnection.

Public Member Functions

 Endpoint (void)
 IP Endpoint (address, port)
void reset_address (void)
 Reset the address of this endpoint.
int set_address (const char *host, const int port)
 Set the address of this endpoint.
char * get_address (void)
 Get the IP address of this endpoint.
int get_port (void)
 Get the port of this endpoint.

Friends

class UDPSocket

Detailed Description

IP Endpoint (address, port)

Definition at line 26 of file Endpoint.h.


Constructor & Destructor Documentation

Endpoint ( void   )

IP Endpoint (address, port)

Definition at line 23 of file Endpoint.cpp.


Member Function Documentation

char * get_address ( void   )

Get the IP address of this endpoint.

Returns:
The IP address of this endpoint.

Definition at line 65 of file Endpoint.cpp.

int get_port ( void   )

Get the port of this endpoint.

Returns:
The port of this endpoint

Definition at line 71 of file Endpoint.cpp.

void reset_address ( void   )

Reset the address of this endpoint.

Definition at line 28 of file Endpoint.cpp.

int set_address ( const char *  host,
const int  port 
)

Set the address of this endpoint.

Parameters:
hostThe endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
portThe endpoint port
Returns:
0 on success, -1 on failure (when an hostname cannot be resolved by DNS).

Definition at line 35 of file Endpoint.cpp.