Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update api.md #188

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
70 changes: 35 additions & 35 deletions docs/api.md
Expand Up @@ -872,7 +872,7 @@ void loop()
}
```

### `begin()`
### `server.begin()`

#### Description

Expand Down Expand Up @@ -931,7 +931,7 @@ void loop()
}
```

### `accept()`
### `server.accept()`

#### Description

Expand Down Expand Up @@ -1015,7 +1015,7 @@ void loop() {
}
```

### `available()`
### `server.available()`

#### Description

Expand Down Expand Up @@ -1130,7 +1130,7 @@ void loop() {
}
```

### `write()`
### `server.write()`

#### Description

Expand Down Expand Up @@ -1197,7 +1197,7 @@ void loop()
}
```

### `print()`
### `server.print()`

#### Description

Expand All @@ -1222,7 +1222,7 @@ byte
print() will return the number of bytes written, though reading that number is optional


### `println()`
### `server.println()`

#### Description

Expand Down Expand Up @@ -1390,7 +1390,7 @@ void loop()

```

### `connected()`
### `client.connected()`

#### Description

Expand Down Expand Up @@ -1457,7 +1457,7 @@ void loop()
}
```

### `connect()`
### `client.connect()`

#### Description

Expand Down Expand Up @@ -1535,7 +1535,7 @@ void loop()
}
```

### `localPort()`
### `client.localPort()`

#### Description

Expand Down Expand Up @@ -1592,7 +1592,7 @@ void loop() {
}
```

### `remoteIP()`
### `client.remoteIP()`

#### Description

Expand Down Expand Up @@ -1649,7 +1649,7 @@ void loop() {
}
```

### `remotePort()`
### `client.remotePort()`

#### Description

Expand Down Expand Up @@ -1706,7 +1706,7 @@ void loop() {
}
```

### `setConnectionTimeout()`
### `client.setConnectionTimeout()`

#### Description

Expand Down Expand Up @@ -1761,7 +1761,7 @@ void loop() {
}
```

### `write()`
### `client.write()`

#### Description

Expand Down Expand Up @@ -1809,7 +1809,7 @@ BASE (optional): the base in which to print numbers: DEC for decimal (base 10),
#### Returns
byte: returns the number of bytes written, though reading that number is optional

### `println()`
### `client.println()`

#### Description

Expand All @@ -1834,7 +1834,7 @@ BASE (optional): the base in which to print numbers: DEC for decimal (base 10),
byte: return the number of bytes written, though reading that number is optional


### `available()`
### `client.available()`

#### Description

Expand Down Expand Up @@ -1903,7 +1903,7 @@ void loop()
}
```

### `read()`
### `client.read()`

#### Description

Expand Down Expand Up @@ -1944,7 +1944,7 @@ none
#### Returns
none

### `stop()`
### `client.stop()`

#### Description

Expand All @@ -1964,9 +1964,9 @@ none
#### Returns
none

# EthernetUDP Class
## EthernetUDP Class

### `UDP.begin()`
### `EthernetUDP.begin()`

#### Description
Initializes the ethernet UDP library and network settings.
Expand Down Expand Up @@ -2038,7 +2038,7 @@ void loop() {

```

### `UDP.read()`
### `EthernetUDP.read()`

#### Description
Reads UDP data from the specified buffer. If no arguments are given, it will return the next character in the buffer.
Expand All @@ -2049,8 +2049,8 @@ This function can only be successfully called after UDP.parsePacket().
#### Syntax

```
UDP.read();
UDP.read(packetBuffer, MaxSize);
EthernetUDP.read();
EthernetUDP.read(packetBuffer, MaxSize);
```

#### Parameters
Expand Down Expand Up @@ -2115,7 +2115,7 @@ void loop() {
}
```

### `UDP.write()`
### `EthernetUDP.write()`

#### Description
Writes UDP data to the remote connection. Must be wrapped between beginPacket() and endPacket(). beginPacket() initializes the packet of data, it is not sent until endPacket() is called.
Expand All @@ -2124,8 +2124,8 @@ Writes UDP data to the remote connection. Must be wrapped between beginPacket()
#### Syntax

```
UDP.write(message);
UDP.write(buffer, size);
EthernetUDP.write(message);
EthernetUDP.write(buffer, size);

```

Expand Down Expand Up @@ -2199,7 +2199,7 @@ void loop() {

```

### `UDP.beginPacket()`
### `EthernetUDP.beginPacket()`

#### Description
Starts a connection to write UDP data to the remote connection
Expand All @@ -2208,7 +2208,7 @@ Starts a connection to write UDP data to the remote connection
#### Syntax

```
UDP.beginPacket(remoteIP, remotePort);
EthernetUDP.beginPacket(remoteIP, remotePort);
```

#### Parameters
Expand Down Expand Up @@ -2251,7 +2251,7 @@ void loop() {
}
```

### `UDP.endPacket()`
### `EthernetUDP.endPacket()`

#### Description
Called after writing UDP data to the remote connection.
Expand All @@ -2260,7 +2260,7 @@ Called after writing UDP data to the remote connection.
#### Syntax

```
UDP.endPacket();
EthernetUDP.endPacket();
```

#### Parameters
Expand Down Expand Up @@ -2303,7 +2303,7 @@ void loop() {
}
```

### `UDP.parsePacket()`
### `EthernetUDP.parsePacket()`

#### Description
Checks for the presence of a UDP packet, and reports the size. parsePacket() must be called before reading the buffer with UDP.read().
Expand All @@ -2312,7 +2312,7 @@ Checks for the presence of a UDP packet, and reports the size. parsePacket() mus
#### Syntax

```
UDP.parsePacket();
EthernetUDP.parsePacket();
```

#### Parameters
Expand Down Expand Up @@ -2361,7 +2361,7 @@ void loop() {
}
```

### `UDP.available()`
### `EthernetUDP.available()`

#### Description

Expand All @@ -2375,7 +2375,7 @@ available() inherits from the Stream utility class.
#### Syntax

```
UDP.available()
EthernetUDP.available()

```

Expand Down Expand Up @@ -2442,7 +2442,7 @@ void loop() {

## UDP class

### `EthernetUDP.stop()`
### `UDP.stop()`

#### Description

Expand All @@ -2452,7 +2452,7 @@ Disconnect from the server. Release any resource being used during the UDP sessi
#### Syntax

```
EthernetUDP.stop()
UDP.stop()

```

Expand Down