# std::basic_syncbuf<CharT,Traits,Allocator>::sync

> C++ Atlas: `cppatlas.com/w/cpp/io/basic_syncbuf/sync` | Source: https://en.cppreference.com/w/cpp/io/basic_syncbuf/sync | Domain: Input/output

First, records that a flush is pending, by updating the appropriate private flag.

## Official Specification Summary (cppreference)

```cpp
protected:
int sync() override;
```

First, records that a flush is pending, by updating the appropriate private flag.

Then, if the current emit-on-sync policy is `true`, makes a call to `emit()`.

Otherwise (if the emit-on-sync policy is `false`, which is the default), the flush is suspended until `emit()` is called, such as through `std::basic_osyncstream::emit()` or `std::basic_osyncstream::~basic_osyncstream`

### Parameters

(none)

### Notes

`sync()` or its equivalent is implicitly called by `close()`, `seekoff()`, and `seekpos()` and explicitly called by `std::basic_streambuf::pubsync()`

### Example

> Note: This section is incomplete Reason: no example

### See also

- [`sync`](https://en.cppreference.com/w/cpp/io/basic_streambuf/pubsync) [virtual]: synchronizes the buffers with the associated character sequence (virtual protected member function of `std::basic_streambuf<CharT,Traits>`)
- [`emit`](https://en.cppreference.com/w/cpp/io/basic_osyncstream/emit): calls `emit()` on the underlying `basic_syncbuf` to transmit its internal data to the final destination (public member function of `std::basic_osyncstream<CharT,Traits,Allocator>`)

---
Attribution: content from https://en.cppreference.com/w/cpp/io/basic_syncbuf/sync (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.