Struct rust_xfinal::Websocket
source · pub struct Websocket { /* private fields */ }Implementations§
source§impl Websocket
impl Websocket
sourcepub fn clone(&self) -> Self
pub fn clone(&self) -> Self
Share the websocket connection
Examples found in repository?
src/http_parser/websocket.rs (line 424)
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
fn switch_to_websocket(
stream: Arc<TcpStream>,
ws_router: Arc<dyn WsRouter + Send + Sync>,
connection_data: Arc<ConnectionData>,
) {
//println!("invoke switch_to_websocket");
let fragment_size: usize = connection_data.server_config.ws_frame_size;
let server_log_open = connection_data.server_config.open_log;
let ws_handler = Websocket {
conn: Arc::clone(&stream),
write_mutex: Arc::new(Mutex::new(())),
fragment_size: fragment_size,
};
let event = WebsocketEvent {
ws: ws_handler.clone(),
message: WsMessage::Open,
};
ws_router.call(event);
let read_stream = Arc::clone(&stream);
let (tx, rx) = mpsc::channel::<WebsocketEvent>();
let _write_thread = thread::spawn(move || loop {
match rx.recv() {
Ok(event) => {
let is_close = if let WsMessage::Close = event.message {
true
} else {
false
};
ws_router.call(event);
if is_close {
break;
}
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket write thread in websocket.rs; type: [RecvError], line: [{}], msg: [{}]",
now,
line!(),
ToString::to_string(&e)
);
}
break;
}
}
});
let _read_thread = thread::spawn(move || {
let inner = read_stream.as_ref();
let sender = tx;
let mut reader = BufReader::new(inner);
'Restart: loop {
let mut data_buffs = Vec::new();
let mut opcode = 0;
let mut first_entry = true;
'ReadFrame: loop {
let mut buff = [b'\0'; 2];
match reader.read_exact(&mut buff) {
Ok(_) => {
let first_byte = buff[0];
let fin = (first_byte >> 7) & 1; // 1是最后一个包或完整的包, 0是分包
// println!(
// "first_entry:{first_entry}, first_byte:{:b}, second_byte:{:b}",
// first_byte, buff[1]
// );
if first_entry {
opcode = first_byte & 0b00001111u8; //如果是分片传输，只记录首次的frame中的opcode
first_entry = false;
}
let second_byte = buff[1];
let mask = (second_byte >> 7) & 1;
if mask != 1 {
break 'Restart;
}
if opcode == 8 {
// //关闭连接
//构造close 通知
break 'Restart;
}
if opcode == 9 {
//ping
// 构造pong消息
ws_handler.write(Vec::new(), 10);
continue 'Restart;
}
if opcode == 10 {
//pong
// 客户端回应pong消息
continue 'Restart;
}
// 其他情况的opcode是消息体
let payload = second_byte & 0b01111111u8;
let data_len = if payload <= 125 {
// 就是data的实际大小
payload as usize
} else if payload == 126 {
// 后两个字节表示长度
let mut two_bytes = [b'\0'; 2];
match reader.read_exact(&mut two_bytes) {
Ok(_) => {
let endian = [
b'\0',
b'\0',
b'\0',
b'\0',
b'\0',
b'\0',
two_bytes[0],
two_bytes[1],
];
usize::from_be_bytes(endian)
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
}
} else if payload == 127 {
// 后 8个字节表示长度
let mut eight_bytes = [b'\0'; 8];
match reader.read_exact(&mut eight_bytes) {
Ok(_) => usize::from_be_bytes(eight_bytes),
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
}
} else {
// payload 无效值
break 'Restart;
}; // data_len end
//println!("data_len: {}", data_len);
// 读取 Masking-key， 4个字节
let mut mask_key_buffs = [b'\0'; 4];
match reader.read_exact(&mut mask_key_buffs) {
Ok(_) => {
// read data part;
let r = read_ws_data(
&mut reader,
data_len,
&mut data_buffs,
mask_key_buffs,
);
//println!("read data part: {r}");
if r == false {
break 'Restart;
} else {
if fin == 1 {
// 构造消息事件
//println!("total size:{}", data_buffs.len());
let event = WebsocketEvent {
ws: ws_handler.clone(),
message: WsMessage::Message(data_buffs, opcode),
};
//println!("{:?}", event.message);
match sender.send(event) {
Ok(_) => {}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [SendError], line: [{}], msg: [{}]",
now,
line!(),
ToString::to_string(&e)
);
}
break 'Restart; // 发送消息错误，关闭当前线程
}
}
continue 'Restart; // 读完完整消息体，重新初始状态等待下一次消息
} else {
//println!("continue to read data");
continue 'ReadFrame; //非完整消息，继续循环ReadFrame块功能
}
}
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
}
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket write thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
};
}
}
let event = WebsocketEvent {
ws: ws_handler.clone(),
message: WsMessage::Close,
};
match sender.send(event) {
Ok(_) => {}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [SendError], line: [{}], msg: [{}]",
now,
line!(),
ToString::to_string(&e)
);
}
}
}
});
}sourcepub fn write(&self, data: Vec<u8>, opcode: u8)
pub fn write(&self, data: Vec<u8>, opcode: u8)
Write the data whose type is specified by the sceond parameter to peer
The method is thread safety
Examples found in repository?
src/http_parser/websocket.rs (line 198)
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
pub fn write_string(&self, s: &str) {
let mut vec = Vec::new();
vec.extend_from_slice(s.as_bytes());
self.write(vec, 1);
}
/// > Conveniently to write binary data to peer
/// >> The method is thread safety
pub fn write_binary(&self, data: Vec<u8>) {
self.write(data, 2);
}
}
pub struct WebsocketEvent {
ws: Websocket,
pub message: WsMessage,
}
impl WebsocketEvent {
pub fn get_conn(&self) -> &Websocket {
&self.ws
}
}
impl Deref for WebsocketEvent {
type Target = Websocket;
fn deref(&self) -> &Self::Target {
&self.ws
}
}
pub(crate) fn construct_http_event_for_websocket(
stream: &mut TcpStream,
method: &str,
url: &str,
http_version: &str,
head_map: &HashMap<&str, &str>,
connection_config: Arc<ConnectionData>,
) -> (bool, Option<Arc<dyn WsRouter + Send + Sync>>) {
let conn = Rc::new(RefCell::new(stream));
let request = Request {
header_pair: head_map.clone(),
url,
method,
version: http_version,
body: BodyContent::None,
conn_: Rc::clone(&conn),
secret_key: Arc::clone(&connection_config.server_config.secret_key),
ctx: RefCell::new(BTreeMap::new()),
};
let mut response = Response {
header_pair: MultiMap::new(),
version: http_version,
method,
//url,
http_state: 200,
body: BodyType::None,
chunked: ResponseChunkMeta::new(connection_config.server_config.chunk_size),
conn_: Rc::clone(&conn),
range: ResponseRangeMeta::None,
request_header: head_map.clone(),
charset: None,
};
let ws_middleware_result = invoke_ws_middlewares(&connection_config, &request, &mut response);
if !ws_middleware_result.0 {
let mut stream = conn.borrow_mut();
if !response.chunked.enable {
match super::write_once(*stream, &mut response) {
Ok(_) => {}
Err(e) => {
if connection_config.server_config.open_log {
let now = super::get_current_date();
println!(
"[{}] >>> error in write_once in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
}
}
} else {
// chunked transfer
match super::write_chunk(*stream, &mut response) {
Ok(_) => {}
Err(e) => {
if connection_config.server_config.open_log {
let now = super::get_current_date();
println!(
"[{}] >>> error in write_chunk in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
}
}
}
(false, None)
} else {
(true, ws_middleware_result.1)
}
}
fn invoke_ws_middlewares_help(result: &WsRouterValue, req: &Request, res: &mut Response) -> bool {
match &result.0 {
Some(middlewares) => {
// at least one middleware
for middleware in middlewares {
if !middleware.call(req, res) {
return false;
}
}
return true;
}
None => true,
}
}
fn invoke_ws_middlewares(
connection_data: &ConnectionData,
req: &Request,
res: &mut Response,
) -> (bool, Option<Arc<dyn WsRouter + Send + Sync>>) {
let url = req.url.split_once("?");
let url = match url {
Some((url, _)) => url,
None => req.url,
};
let ws_router_map = &connection_data.ws_router_map;
let not_found = connection_data
.router_map
.get("NEVER_FOUND_FOR_ALL")
.unwrap();
match ws_router_map.get(url) {
Some(result) => {
return (
invoke_ws_middlewares_help(result, req, res),
Some(Arc::clone(&result.1)),
);
}
None => {
not_found.1.call(req, res);
return (false, None);
}
}
}
pub(crate) fn handle_websocket_connection(
mut stream: TcpStream,
header: HashMap<&str, &str>,
ws_version: String,
secret_key: String,
ws_router: Arc<dyn WsRouter + Send + Sync>,
connection_data: Arc<ConnectionData>,
) {
//println!("handle_websocket_connection");
let mut request_meta_header: HashMap<String, String> = HashMap::new();
for (k, v) in header {
request_meta_header.insert(k.to_string(), v.to_string());
}
let key = format!("{}258EAFA5-E914-47DA-95CA-C5AB0DC85B11", secret_key);
let mut hasher = Sha1::new();
hasher.update(key.as_bytes());
let hash = hasher.finalize();
let result: &[u8] = hash.as_ref();
let r = base64::encode(result);
//println!("websocket: {r}");
//let shared_tcp_connection = Arc::new(stream);
let response = format!("HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Version:{}\r\nSec-WebSocket-Accept:{}\r\n\r\n",ws_version,r);
match stream.write(response.as_bytes()) {
Ok(_) => {
let _ = stream.set_read_timeout(Some(std::time::Duration::from_millis(
connection_data.server_config.ws_read_timeout as u64,
)));
let _ = stream.set_write_timeout(Some(std::time::Duration::from_millis(
connection_data.server_config.ws_write_timeout as u64,
)));
switch_to_websocket(Arc::new(stream), ws_router, connection_data);
}
Err(_) => {}
}
}
fn read_ws_data(
reader: &mut BufReader<&TcpStream>,
data_len: usize,
data_buffs: &mut Vec<u8>,
mask_key: [u8; 4],
) -> bool {
let current_len = data_buffs.len();
data_buffs.resize(current_len + data_len, b'\0');
//println!("current pos:{current_len}, size:{}", current_len + data_len);
match reader.read_exact(&mut data_buffs[current_len..]) {
Ok(_) => {
decode_ws_data(&mut data_buffs[current_len..], mask_key);
true
}
Err(_) => false,
}
}
fn decode_ws_data(raw_data: &mut [u8], mask_key: [u8; 4]) {
let mut i = 0;
let len = raw_data.len();
while i < len {
let j = i % 4;
let r = raw_data[i] ^ mask_key[j];
raw_data[i] = r;
i += 1;
}
}
fn switch_to_websocket(
stream: Arc<TcpStream>,
ws_router: Arc<dyn WsRouter + Send + Sync>,
connection_data: Arc<ConnectionData>,
) {
//println!("invoke switch_to_websocket");
let fragment_size: usize = connection_data.server_config.ws_frame_size;
let server_log_open = connection_data.server_config.open_log;
let ws_handler = Websocket {
conn: Arc::clone(&stream),
write_mutex: Arc::new(Mutex::new(())),
fragment_size: fragment_size,
};
let event = WebsocketEvent {
ws: ws_handler.clone(),
message: WsMessage::Open,
};
ws_router.call(event);
let read_stream = Arc::clone(&stream);
let (tx, rx) = mpsc::channel::<WebsocketEvent>();
let _write_thread = thread::spawn(move || loop {
match rx.recv() {
Ok(event) => {
let is_close = if let WsMessage::Close = event.message {
true
} else {
false
};
ws_router.call(event);
if is_close {
break;
}
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket write thread in websocket.rs; type: [RecvError], line: [{}], msg: [{}]",
now,
line!(),
ToString::to_string(&e)
);
}
break;
}
}
});
let _read_thread = thread::spawn(move || {
let inner = read_stream.as_ref();
let sender = tx;
let mut reader = BufReader::new(inner);
'Restart: loop {
let mut data_buffs = Vec::new();
let mut opcode = 0;
let mut first_entry = true;
'ReadFrame: loop {
let mut buff = [b'\0'; 2];
match reader.read_exact(&mut buff) {
Ok(_) => {
let first_byte = buff[0];
let fin = (first_byte >> 7) & 1; // 1是最后一个包或完整的包, 0是分包
// println!(
// "first_entry:{first_entry}, first_byte:{:b}, second_byte:{:b}",
// first_byte, buff[1]
// );
if first_entry {
opcode = first_byte & 0b00001111u8; //如果是分片传输，只记录首次的frame中的opcode
first_entry = false;
}
let second_byte = buff[1];
let mask = (second_byte >> 7) & 1;
if mask != 1 {
break 'Restart;
}
if opcode == 8 {
// //关闭连接
//构造close 通知
break 'Restart;
}
if opcode == 9 {
//ping
// 构造pong消息
ws_handler.write(Vec::new(), 10);
continue 'Restart;
}
if opcode == 10 {
//pong
// 客户端回应pong消息
continue 'Restart;
}
// 其他情况的opcode是消息体
let payload = second_byte & 0b01111111u8;
let data_len = if payload <= 125 {
// 就是data的实际大小
payload as usize
} else if payload == 126 {
// 后两个字节表示长度
let mut two_bytes = [b'\0'; 2];
match reader.read_exact(&mut two_bytes) {
Ok(_) => {
let endian = [
b'\0',
b'\0',
b'\0',
b'\0',
b'\0',
b'\0',
two_bytes[0],
two_bytes[1],
];
usize::from_be_bytes(endian)
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
}
} else if payload == 127 {
// 后 8个字节表示长度
let mut eight_bytes = [b'\0'; 8];
match reader.read_exact(&mut eight_bytes) {
Ok(_) => usize::from_be_bytes(eight_bytes),
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
}
} else {
// payload 无效值
break 'Restart;
}; // data_len end
//println!("data_len: {}", data_len);
// 读取 Masking-key， 4个字节
let mut mask_key_buffs = [b'\0'; 4];
match reader.read_exact(&mut mask_key_buffs) {
Ok(_) => {
// read data part;
let r = read_ws_data(
&mut reader,
data_len,
&mut data_buffs,
mask_key_buffs,
);
//println!("read data part: {r}");
if r == false {
break 'Restart;
} else {
if fin == 1 {
// 构造消息事件
//println!("total size:{}", data_buffs.len());
let event = WebsocketEvent {
ws: ws_handler.clone(),
message: WsMessage::Message(data_buffs, opcode),
};
//println!("{:?}", event.message);
match sender.send(event) {
Ok(_) => {}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [SendError], line: [{}], msg: [{}]",
now,
line!(),
ToString::to_string(&e)
);
}
break 'Restart; // 发送消息错误，关闭当前线程
}
}
continue 'Restart; // 读完完整消息体，重新初始状态等待下一次消息
} else {
//println!("continue to read data");
continue 'ReadFrame; //非完整消息，继续循环ReadFrame块功能
}
}
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
}
}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket write thread in websocket.rs; type: [{}], line: [{}], msg: [{}]",
now,
e.kind().to_string(),
line!(),
ToString::to_string(&e)
);
}
break 'Restart;
}
};
}
}
let event = WebsocketEvent {
ws: ws_handler.clone(),
message: WsMessage::Close,
};
match sender.send(event) {
Ok(_) => {}
Err(e) => {
if server_log_open {
let now = super::get_current_date();
println!(
"[{}] >>> error in websocket read thread in websocket.rs; type: [SendError], line: [{}], msg: [{}]",
now,
line!(),
ToString::to_string(&e)
);
}
}
}
});
}sourcepub fn write_string(&self, s: &str)
pub fn write_string(&self, s: &str)
Conveniently to write string data to peer
The method is thread safety
sourcepub fn write_binary(&self, data: Vec<u8>)
pub fn write_binary(&self, data: Vec<u8>)
Conveniently to write binary data to peer
The method is thread safety