xtr.dev/rondevu-client
1
0
Fork 0
mirror of https://github.com/xtr-dev/rondevu-client.git synced 2025-12-13 20:33:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove RondevuSignaler documentation and outdated files

Browse Source 
- Remove entire RondevuSignaler class documentation section
- Remove PollingConfig interface from Types section
- Delete obsolete USAGE.md file (completely outdated)
- Update all examples to use new automatic API
- Fix migration examples to show current publishService() format
This commit is contained in:
Bas van den Aakster
2025-12-12 22:43:48 +01:00
parent 43dfd72c3d
commit 4345709e9c
2 changed files with 13 additions and 388 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
README.md
View File

@@ -273,74 +273,6 @@ await rondevu.getOfferIceCandidates(
): Promise<{ candidates: IceCandidate[], offerId: string }>
```
### RondevuSignaler Class
Higher-level signaling abstraction with automatic polling and event listeners.
```typescript
import { RondevuSignaler } from '@xtr-dev/rondevu-client'
const signaler = new RondevuSignaler(
rondevu: Rondevu,
service: string, // Service FQN without username (e.g., 'chat:1.0.0')
host?: string, // Optional: target username for answerer
pollingConfig?: {
initialInterval?: number // Default: 500ms
maxInterval?: number // Default: 5000ms
backoffMultiplier?: number // Default: 1.5
maxRetries?: number // Default: 50
jitter?: boolean // Default: true
}
)
```
#### Offerer Side
```typescript
// Set offer (automatically starts polling for answer and ICE)
await signaler.setOffer(offer: RTCSessionDescriptionInit): Promise<void>
// Listen for answer
const unbind = signaler.addAnswerListener((answer) => {
console.log('Received answer:', answer)
})
// Listen for ICE candidates
signaler.addListener((candidate) => {
console.log('Received ICE candidate:', candidate)
})
// Send ICE candidate
await signaler.addIceCandidate(candidate: RTCIceCandidate): Promise<void>
```
#### Answerer Side
```typescript
// Listen for offer (automatically searches for service)
const unbind = signaler.addOfferListener((offer) => {
console.log('Received offer:', offer)
})
// Set answer (automatically starts polling for ICE)
await signaler.setAnswer(answer: RTCSessionDescriptionInit): Promise<void>
// Send ICE candidate
await signaler.addIceCandidate(candidate: RTCIceCandidate): Promise<void>
// Listen for ICE candidates
signaler.addListener((candidate) => {
console.log('Received ICE candidate:', candidate)
})
```
#### Cleanup
```typescript
// Stop all polling and cleanup
signaler.dispose(): void
```
### RondevuAPI Class
Low-level HTTP API client (used internally by Rondevu class).
@@ -416,14 +348,6 @@ interface IceCandidate {
candidate: RTCIceCandidateInit
createdAt: number
}
interface PollingConfig {
initialInterval?: number // Default: 500ms
maxInterval?: number // Default: 5000ms
backoffMultiplier?: number // Default: 1.5
maxRetries?: number // Default: 50
jitter?: boolean // Default: true
}
```
## Advanced Usage
@@ -442,8 +366,10 @@ console.log(rondevu.getUsername()) // e.g., "anon-lx2w34-a3f501"
// Anonymous users behave exactly like regular users
await rondevu.publishService({
service: 'chat:1.0.0',
offers: [{ sdp: offerSdp }]
maxOffers: 5
})
await rondevu.startFilling()
```
### Persistent Keypair
@@ -510,23 +436,6 @@ const service = await rondevu.publishService({
console.log(`Published ${service.offers.length} offers`)
```
### Custom Polling Configuration
```typescript
const signaler = new RondevuSignaler(
rondevu,
'chat:1.0.0',
'alice',
{
initialInterval: 1000, // Start at 1 second
maxInterval: 10000, // Max 10 seconds
backoffMultiplier: 2, // Double each time
maxRetries: 30, // Stop after 30 retries
jitter: true // Add randomness
}
)
```
## Platform Support
### Modern Browsers
@@ -588,14 +497,13 @@ const pc = new RTCPeerConnection(rtcConfig)
const dc = pc.createDataChannel('chat')
// Publish service (username auto-claimed on first publish)
const offer = await pc.createOffer()
await pc.setLocalDescription(offer)
await rondevu.publishService({
service: 'chat:1.0.0',
offers: [{ sdp: offer.sdp }]
maxOffers: 5
})
await rondevu.startFilling()
// Browser clients can now discover and connect to chat:1.0.0@mybot
```
@@ -616,7 +524,8 @@ v0.4.0 removes high-level abstractions and uses manual WebRTC setup:
**Added:**
- `pollOffers()` - Combined polling for answers and ICE candidates
- `RondevuSignaler` - Simplified signaling with automatic polling
- `publishService()` - Automatic offer pool management
- `connectToService()` - Automatic answering side setup
**Migration Example:**
@@ -628,16 +537,13 @@ const host = new ServiceHost({
})
await host.start()
// After (v0.4.0) - Manual setup
const pc = new RTCPeerConnection()
const dc = pc.createDataChannel('chat')
const offer = await pc.createOffer()
await pc.setLocalDescription(offer)
// After (v0.4.0+) - Automatic setup
await rondevu.publishService({
serviceFqn: 'chat:1.0.0@alice',
offers: [{ sdp: offer.sdp }]
service: 'chat:1.0.0',
maxOffers: 5
})
await rondevu.startFilling()
```
## License