File: mg_lock_connection.md

package info (click to toggle)
civetweb 1.13%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 4,296 kB
  • sloc: ansic: 30,345; cpp: 1,148; sh: 388; javascript: 204; python: 143; makefile: 92; perl: 6; php: 1
file content (26 lines) | stat: -rw-r--r-- 962 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Civetweb API Reference

### `mg_lock_connection( conn );`

### Parameters

| Parameter | Type | Description |
|**`conn`**|`struct mg_connection *`|The connection to retrieve a lock|

### Return Value

*none*

### Description

The function `mg_lock_connection()` is specifically for websocket connections to lock connection. Using this function in combination with [`mg_unlock_connection();`](mg_unlock_connection.md) is necessary around [`mg_write()`](mg_write.md) and [`mg_printf()`](mg_printf.md) calls if the code has server-initiated communication, as well as with communication in direct response to a message.

### See Also

* [`mg_lock_context();`](mg_lock_context.md)
* [`mg_printf();`](mg_printf.md)
* [`mg_unlock_connection();`](mg_unlock_connection.md)
* [`mg_unlock_context();`](mg_unlock_context.md)
* [`mg_websocket_client_write();`](mg_websocket_client_write.md)
* [`mg_websocket_write();`](mg_websocket_write.md)
* [`mg_write();`](mg_write.md)