xwrust/xwmd/xwmq.rs
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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 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 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
//! XWOS RUST：消息队列
//! ========
//!
//! XWOS RUST的消息队列是仿照 [`std::sync::mpsc`] 编写的。可以有多个发送者，但只能有一个接收者。
//!
//! XWOS RUST的消息队列是一个先进先进（FIFO）队列。
//!
//! 消息队列在创建时，需要指定一个类型 `T` ，发送和接收的数据只能是类型 `T` 的数据。
//! 发送时，消息队列会通过 [`Box`] 将类型 `T` 的数据存入堆内存中。然后将 `Box<T>` 的裸指针发送到队列。
//! 可以发送到尾端（入队 [`XwmqTx::eq()`] ），也可将消息发送到队列的首端（插队 [`XwmqTx::jq()`] ）。
//!
//! 接收时，会从队列中取出 `T` 的裸指针，然后恢复成 `Box<T>` 后返回，由于 [`Box`] 能自动释放内存，因此用户不需要关心内存释放的问题。
//! 接收消息可以从首端接收，也可以从尾端接收。
//!
//!
//! # 创建
//!
//! XWOS RUST的消息队列可使用 [`Xwmq::new()`] 创建。创建时需要指定两个类型参数：发送消息槽的个数以及消息数据的类型。
//!
//! + 可以创建具有静态生命周期 [`static`] 约束的全局变量：
//!
//! ```rust
//! use xwrust::xwmd::xwmq::*;
//!
//! static MQ: Xwmq<16, String> = Xwmq::new(); // 16个消息槽，数据类型为String
//! ```
//!
//! + 也可以使用 [`alloc::sync::Arc`] 在heap中创建：
//!
//! ```rust
//! extern crate alloc;
//! use alloc::sync::Arc;
//!
//! use xwrust::xwmd::xwmq::*;
//!
//! pub fn xwrust_example_xwmq() {
//! let mq: Arc<Xwmq<16, String>> = Arc::new(Xwmq::new()); // 16个消息槽，数据类型为 `String`
//! }
//! ```
//!
//!
//! # 初始化
//!
//! 无论以何种方式创建的消息队列，都必须在使用前调用 [`Xwmq::init()`] 进行初始化，
//! 初始化后会返回消息队列的发送者 [`XwmqTx`] 以及接收者 [`XwmqRx`] 。
//!
//! ```rust
//! pub fn xwrust_example_xwmq() {
//! let (tx, rx) = MQ.init();
//! }
//! ```
//!
//!
//! # 发送
//!
//! [`Xwmq`] 的发送者 [`XwmqTx`] 具有 [`Send`] 约束，可在线程之间转移所有权，但不能在线程之间共享( [`!Sync`] )。
//!
//! 发送者 [`XwmqTx`] 可被 [`XwmqTx::clone()`] 为多个发送者，由不同线程持有，向接收者 [`XwmqRx`] 发送消息。
//!
//! ## 入队
//!
//! **入队** 方式是将消息发送到队列的 **尾端** ， **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
//!
//! ### 等待入队
//!
//! 方法 [`XwmqTx::eq()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
//! + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，并发送数据。
//! + 当线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
//!
//! ### 超时等待入队
//!
//! 方法 [`XwmqTx::eq_to()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待，等待时会指定一个唤醒时间点。
//! + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，并发送数据。
//! + 当线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
//! + 当到达指定的唤醒时间点，线程被唤醒，并返回 [`XwmqError::Timedout`] 。
//!
//! ### 等待入队，且等待不可不中断
//!
//! 方法 [`XwmqTx::eq_unintr()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
//! + 发送线程的阻塞等待不可被中断。
//! + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，并发送数据。
//!
//! ### 尝试等待入队
//!
//! 方法 [`XwmqTx::tryeq()`] 方法可在 **任意** 上下文中使用，不会阻塞，只会检测信号量的值：
//!
//! + 当消息队列中没有可用的消息槽可用时，立即返回 [`XwmqError::NoSlot`] 。
//! + 当消息队列中有可用的消息槽时，发送线程会取走一个消息槽，并发送数据。
//!
//! ## 插队
//!
//! **插队** 方式是将消息发送到队列的 **首端** ， **插队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
//!
//! ### 等待插队
//!
//! 方法 [`XwmqTx::jq()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
//! + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，并发送数据。
//! + 当线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
//!
//! ### 超时等待插队
//!
//! 方法 [`XwmqTx::jq_to()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待，等待时会指定一个唤醒时间点。
//! + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，并发送数据。
//! + 当线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
//! + 当到达指定的唤醒时间点，线程被唤醒，并返回 [`XwmqError::Timedout`] 。
//!
//! 方法 [`XwmqTx::jq_unintr()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
//! + 发送线程的阻塞等待不可被中断。
//! + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，并发送数据。
//!
//! ### 尝试等待插队
//!
//! 方法 [`XwmqTx::tryjq()`] 方法可在 **任意** 上下文中使用，不会阻塞，只会检测信号量的值：
//!
//! + 当消息队列中没有可用的消息槽可用时，立即返回 [`XwmqError::NoSlot`] 。
//! + 当消息队列中有可用的消息槽时，发送线程会取走一个消息槽，并发送数据。
//!
//!
//! # 接收
//!
//! [`Xwmq`] 的接收者 [`XwmqRx`] 具有 [`Send`] 约束，可在线程之间转移所有权，但不能在线程之间共享( [`!Sync`] )。
//!
//! 接收者 [`XwmqRx`] 不可被 ”**克隆**“，因为接收者只能有一个。
//!
//! 接收消息后，会释放消息槽。若有发送线程正在等待消息槽，将唤醒发送线程。
//!
//! ## 首端离队
//!
//! 从消息队列的 **首端** 取出消息，称为 **首端离队** 。
//! 接收成功，消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
//! 当 [`Box`] 被 [`drop()`] 时，会自动释放heap内存。
//!
//! ### 等待离队
//!
//! 方法 [`XwmqRx::dq()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有消息时，接收线程会阻塞等待。
//! + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，并释放消息槽。
//! + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
//!
//! ### 超时等待离队
//!
//! 方法 [`XwmqRx::dq_to()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有消息时，接收线程会阻塞等待，等待时会指定一个唤醒时间点。
//! + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
//! + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
//! + 当到达指定的唤醒时间点，线程被唤醒，并通过 [`Err()`] 返回 [`XwmqError::Timedout`] 。
//!
//! 方法 [`XwmqRx::dq_unintr()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有消息时，接收线程会阻塞等待。
//! + 接收线程的阻塞等待不可被中断。
//! + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，并释放消息槽。
//!
//! ### 尝试等待离队
//!
//! 方法 [`XwmqRx::trydq()`] 方法可在 **任意** 上下文中使用，不会阻塞，只会检测信号量的值：
//!
//! + 当消息队列中没有消息时，立即通过 [`Err()`] 返回 [`XwmqError::NoMsg`] 。
//! + 当消息队列中有可用的消息时，接收线程会取走一个消息，并释放消息槽。
//!
//! ## 尾端离队
//!
//! 从消息队列的 **尾端** 取出消息，称为 **尾端离队** 。
//! 接收成功，消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，
//! 然后通过 [`Ok()`] 返回。
//! 当 [`Box`] 被 [`drop()`] 时，会自动释放heap内存。
//!
//! ### 等待反向离队
//!
//! 方法 [`XwmqRx::rq()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有消息时，接收线程会阻塞等待。
//! + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，并释放消息槽。
//! + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
//!
//! ### 超时等待反向离队
//!
//! 方法 [`XwmqRx::rq_to()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有消息时，接收线程会阻塞等待，等待时会指定一个唤醒时间点。
//! + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
//! + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
//! + 当到达指定的唤醒时间点，线程被唤醒，并通过 [`Err()`] 返回 [`XwmqError::Timedout`] 。
//!
//! 方法 [`XwmqRx::rq_unintr()`] 只可在 **线程** 上下文中使用：
//!
//! + 当消息队列中没有消息时，接收线程会阻塞等待。
//! + 接收线程的阻塞等待不可被中断。
//! + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，并释放消息槽。
//!
//! ### 尝试等待反向离队
//!
//! 方法 [`XwmqRx::tryrq()`] 方法可在 **任意** 上下文中使用，不会阻塞，只会检测信号量的值：
//!
//! + 当消息队列中没有消息时，立即通过 [`Err()`] 返回 [`XwmqError::NoMsg`] 。
//! + 当消息队列中有可用的消息时，接收线程会取走一个消息，并释放消息槽。
//!
//!
//! # 示例
//!
//! [XWOS/xwam/xwrust-example/xwrust_example_xwmq](https://gitee.com/xwos/XWOS/blob/main/xwam/xwrust-example/xwrust_example_xwmq/src/lib.rs)
//!
//!
//! # 对比 [`std::sync::mpsc`]
//!
//!
//! + XWOS RUST:
//!
//! ```rust
//! #![no_std]
//!
//! extern crate alloc;
//!
//! use xwrust::xwos::thd;
//! use xwrust::xwmd::xwmq::*;
//!
//! static MQ: Xwmq<16, u32> = Xwmq::new();
//!
//! pub fn xwrust_example_xwmq() {
//! println!("XWOS RUST Example: XWMQ");
//! let (tx, rx) = MQ.init();
//!
//! let _ = thd::Builder::new()
//! .spawn(move |_| { // 子线程闭包
//! tx.eq(53);
//! "OK"
//! });
//!
//! let rc = rx.dq();
//! match rc {
//! Ok(d) => { // d为接收到的数据，并被放在智能指针Box中
//! },
//! Err(e) => {
//! },
//! };
//! }
//! ```
//!
//! + [`std::sync::mpsc`]
//!
//! ```rust
//! use std::thread;
//! use std::sync::mpsc::sync_channel;
//!
//! let (tx, rx) = sync_channel::<i32>(0);
//! thread::spawn(move|| {
//! tx.send(53).unwrap();
//! });
//! rx.recv().unwrap();
//! ```
//!
//! ### 构建全局变量的方式
//!
//! + [`std::sync::mpsc`] 没有编译期构造函数，因此只能借助
//! 宏 [`lazy_static!`] 创建全局变量；
//! + [`xwrust::xwmd::xwmq`] 则可以直接在函数外部定义。
//!
//!
//! ### 通道类型
//!
//! + [`std::sync::mpsc`] 还有异步的通道 [`std::sync::mpsc::channel()`] ；
//! + [`xwrust::xwmd::xwmq`] 通过 [`Xwmq::init()`] 返回的是类似于
//! [`std::sync::mpsc::sync_channel()`] 的通道，
//! [`xwrust::xwmd::xwmq`] 没有异步的通道 。
//!
//! ### 接收消息返回方式不同
//!
//! + [`std::sync::mpsc`] 接收到消息后，直接返回类型为 **T** 的消息；
//! + [`xwrust::xwmd::xwmq`] 则返回 `Box<T>` 。
//!
//! [`std::sync::mpsc`]: <https://doc.rust-lang.org/std/sync/mpsc/index.html>
//! [`std::sync::mpsc::channel()`]: <https://doc.rust-lang.org/std/sync/mpsc/fn.channel.html>
//! [`std::sync::mpsc::sync_channel()`]: <https://doc.rust-lang.org/std/sync/mpsc/fn.sync_channel.html>
//! [`static`]: <https://doc.rust-lang.org/std/keyword.static.html>
//! [`alloc::sync::Arc`]: <https://doc.rust-lang.org/alloc/sync/struct.Arc.html>
//! [`Send`]: <https://doc.rust-lang.org/core/marker/trait.Send.html>
//! [`Sync`]: <https://doc.rust-lang.org/core/marker/trait.Sync.html>
//! [`lazy_static!`]: <https://lib.rs/crates/lazy_static>
//! [`!Sync`]: <https://doc.rust-lang.org/core/marker/trait.Sync.html>
//! [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
//! [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
//! [`drop()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.drop>
//! [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
//! [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
//! [`xwrust::xwmd::xwmq`]: crate::xwmd::xwmq
extern crate core;
use core::ffi::*;
use core::result::Result;
use core::cell::UnsafeCell;
use core::ptr;
use core::marker::PhantomData;
extern crate alloc;
use alloc::boxed::Box;
use crate::types::*;
use crate::errno::*;
extern "C" {
fn xwmq_init(mq: *mut XwmdXwmq, txq: *mut c_void, num: XwSz) -> XwEr;
fn xwmq_fini(mq: *mut XwmdXwmq) -> XwEr;
fn xwmq_grab(mq: *mut XwmdXwmq) -> XwEr;
fn xwmq_put(mq: *mut XwmdXwmq) -> XwEr;
fn xwmq_get_tik(mq: *mut XwmdXwmq) -> XwSq;
fn xwrustffi_xwmq_acquire(mq: *mut XwmdXwmq, tik: XwSq) -> XwEr;
fn xwrustffi_xwmq_release(mq: *mut XwmdXwmq, tik: XwSq) -> XwEr;
fn xwmq_eq(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void) -> XwEr;
fn xwmq_eq_to(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void, to: XwTm) -> XwEr;
fn xwmq_tryeq(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void) -> XwEr;
fn xwmq_eq_unintr(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void) -> XwEr;
fn xwmq_jq(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void) -> XwEr;
fn xwmq_jq_to(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void, to: XwTm) -> XwEr;
fn xwmq_jq_unintr(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void) -> XwEr;
fn xwmq_tryjq(mq: *mut XwmdXwmq, topic: XwSq, data: *mut c_void) -> XwEr;
fn xwmq_dq(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void) -> XwEr;
fn xwmq_dq_to(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void, to: XwTm) -> XwEr;
fn xwmq_dq_unintr(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void) -> XwEr;
fn xwmq_trydq(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void) -> XwEr;
fn xwmq_rq(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void) -> XwEr;
fn xwmq_rq_to(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void, to: XwTm) -> XwEr;
fn xwmq_rq_unintr(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void) -> XwEr;
fn xwmq_tryrq(mq: *mut XwmdXwmq, topic: *mut XwSq, data: *mut *mut c_void) -> XwEr;
}
/// 消息队列的错误码
#[derive(Debug)]
pub enum XwmqError {
/// 没有错误
Ok(XwEr),
/// 消息队列没有初始化
NotInit(XwEr),
/// 等待被中断
Interrupt(XwEr),
/// 等待超时
Timedout(XwEr),
/// 不在线程上下文内
NotThreadContext(XwEr),
/// 抢占被关闭
DisPmpt(XwEr),
/// 中断底半部被关闭
DisBh(XwEr),
/// 中断被关闭
DisIrq(XwEr),
/// 消息队列中没有可用的消息槽
NoSlot(XwEr),
/// 消息队列中没有消息
NoMsg(XwEr),
/// 未知错误
Unknown(XwEr),
}
impl XwmqError {
/// 消费掉 `XwmqError` 自身，返回内部的错误码。
pub fn unwrap(self) -> XwEr {
match self {
Self::Ok(rc) => rc,
Self::NotInit(rc) => rc,
Self::Interrupt(rc) => rc,
Self::Timedout(rc) => rc,
Self::NotThreadContext(rc) => rc,
Self::DisPmpt(rc) => rc,
Self::DisBh(rc) => rc,
Self::DisIrq(rc) => rc,
Self::NoSlot(rc) => rc,
Self::NoMsg(rc) => rc,
Self::Unknown(rc) => rc,
}
}
/// 如果信号量的错误码是 [`XwmqError::Ok`] ，返回 `true` 。
pub const fn is_ok(&self) -> bool {
matches!(*self, Self::Ok(_))
}
/// 如果信号量的错误码不是 [`XwmqError::Ok`] ，返回 `true` 。
pub const fn is_err(&self) -> bool {
!self.is_ok()
}
}
/// 消息队列对象占用的内存大小
#[cfg(target_pointer_width = "32")]
pub const SIZEOF_XWMQ: usize = 200;
/// 消息占用的内存大小
#[cfg(target_pointer_width = "32")]
pub const SIZEOF_XWMQ_MSG: usize = 16;
/// 消息队列对象占用的内存大小
#[cfg(target_pointer_width = "64")]
pub const SIZEOF_XWMQ: usize = 400;
/// 消息占用的内存大小
#[cfg(target_pointer_width = "64")]
pub const SIZEOF_XWMQ_MSG: usize = 32;
/// 用于构建消息队列的内存数组类型
#[repr(C)]
#[cfg_attr(target_pointer_width = "32", repr(align(8)))]
#[cfg_attr(target_pointer_width = "64", repr(align(16)))]
pub(crate) struct XwmdXwmq {
pub(crate) obj: [u8; SIZEOF_XWMQ],
}
/// 用于构建消息槽的内存数组类型
#[repr(C)]
#[cfg_attr(target_pointer_width = "32", repr(align(8)))]
#[cfg_attr(target_pointer_width = "64", repr(align(16)))]
pub(crate) struct XwmdXwmqMsg<const N: XwSz>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{
pub(crate) obj: [u8; N * SIZEOF_XWMQ_MSG],
}
/// 用于构建消息队列的内存数组常量
///
/// 此常量的作用是告诉编译器消息队列对象需要多大的内存。
pub(crate) const XWMQ_INITIALIZER: XwmdXwmq = XwmdXwmq {
obj: [0; SIZEOF_XWMQ],
};
/// 消息队列对象结构体
pub struct Xwmq<const N: XwSz, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{
/// 用于初始化消息队列对象的内存空间
pub(crate) mq: UnsafeCell<XwmdXwmq>,
/// 用于初始化消息池的内存空间
pub(crate) pool: UnsafeCell<XwmdXwmqMsg<N>>,
/// 消息队列对象的标签
pub(crate) tik: UnsafeCell<XwSq>,
phantom: PhantomData<T>,
}
unsafe impl<const N: XwSz, T> Send for Xwmq<N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{}
unsafe impl<const N: XwSz, T> Sync for Xwmq<N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{}
impl<const N: XwSz, T> Xwmq<N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{
/// 新建消息队列对象
///
/// 此方法是编译期方法。
///
/// # 示例
///
/// + 具有 [`static`] 约束的全局变量全局变量：
///
/// ```rust
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new(); // 16个消息槽，数据类型为String
/// ```
///
/// + 在heap中创建：
///
/// ```rust
/// extern crate alloc;
/// use alloc::sync::Arc;
///
/// use xwrust::xwmd::xwmq::*;
///
/// pub fn xwrust_example_xwmq() {
/// let mq: Arc<Xwmq<16, String>> = Arc::new(Xwmq::new()); // 16个消息槽，数据类型为String
/// }
/// ```
///
/// [`static`]: https://doc.rust-lang.org/std/keyword.static.html
pub const fn new() -> Self {
Self {
mq: UnsafeCell::new(XWMQ_INITIALIZER),
pool: UnsafeCell::new(XwmdXwmqMsg { obj: [0; N * SIZEOF_XWMQ_MSG] }),
tik: UnsafeCell::new(0),
phantom: PhantomData,
}
}
/// 初始化消息队列对象
///
/// 消息队列对象必须调用此方法一次，方可正常使用。
/// 初始化后会返回消息队列的发送者 [`XwmqTx`] 以及接收者 [`XwmqRx`] 。
///
/// # 示例
///
/// ```rust
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// }
/// ```
pub fn init<'a>(&'a self) -> (XwmqTx<'a, N, T>, XwmqRx<'a, N, T>) {
unsafe {
xwmq_init(self.mq.get(), self.pool.get() as _, N);
*self.tik.get() = xwmq_get_tik(self.mq.get());
}
(XwmqTx {xwmq: &self}, XwmqRx {xwmq: &self})
}
}
#[derive(Clone)]
pub struct XwmqTx<'a, const N: XwSz, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{
xwmq: &'a Xwmq<N, T>,
}
pub struct XwmqRx<'a, const N: XwSz, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{
xwmq: &'a Xwmq<N, T>,
}
unsafe impl<'a, const N: XwSz, T> Send for XwmqTx<'a, N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{}
impl<'a, const N: XwSz, T> !Sync for XwmqTx<'a, N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{}
unsafe impl<'a, const N: XwSz, T> Send for XwmqRx<'a, N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{}
impl<'a, const N: XwSz, T> !Sync for XwmqRx<'a, N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{}
impl<'a, const N: XwSz, T> XwmqTx<'a, N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{
/// 等待消息槽，成功后将消息发送到消息队列的 **尾端** （入队）
///
/// + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
/// + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
/// + 当发送线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.eq("message".to_string());
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn eq(&self, data: T) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_eq(self.xwmq.mq.get(), 0, raw as *mut c_void);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -EINTR == rc {
XwmqError::Interrupt(rc)
} else if -ENOTTHDCTX == rc {
XwmqError::NotThreadContext(rc)
} else if -EDISPMPT == rc {
XwmqError::DisPmpt(rc)
} else if -EDISBH == rc {
XwmqError::DisBh(rc)
} else if -EDISIRQ == rc {
XwmqError::DisIrq(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
/// 限时等待消息槽，成功后将消息发送到消息队列的 **尾端** （入队）
///
/// + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待，等待时会指定一个唤醒时间点。
/// + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
/// + 当发送线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
/// + 当到达指定的唤醒时间点，线程被唤醒，并返回 [`XwmqError::Timedout`] 。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
/// + to: 期望唤醒的时间点
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::Timedout`] 等待超时
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwtm;
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.eq_to("message".to_string(), xwtm::ft(xwtm::s(1)));
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn eq_to(&self, data: T, to: XwTm) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_eq_to(self.xwmq.mq.get(), 0, raw as *mut c_void, to);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -EINTR == rc {
XwmqError::Interrupt(rc)
} else if -ETIMEDOUT == rc {
XwmqError::Timedout(rc)
} else if -ENOTTHDCTX == rc {
XwmqError::NotThreadContext(rc)
} else if -EDISPMPT == rc {
XwmqError::DisPmpt(rc)
} else if -EDISBH == rc {
XwmqError::DisBh(rc)
} else if -EDISIRQ == rc {
XwmqError::DisIrq(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
/// 等待消息槽，且等待不可被中断，成功后将消息发送到消息队列的 **尾端** （入队）
///
/// + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
/// + 发送线程的阻塞等待不可被中断。
/// + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.eq_unintr("message".to_string());
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn eq_unintr(&self, data: T) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_eq_unintr(self.xwmq.mq.get(), 0, raw as *mut c_void);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -ENOTTHDCTX == rc {
XwmqError::NotThreadContext(rc)
} else if -EDISPMPT == rc {
XwmqError::DisPmpt(rc)
} else if -EDISBH == rc {
XwmqError::DisBh(rc)
} else if -EDISIRQ == rc {
XwmqError::DisIrq(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
/// 尝试获取消息槽，成功后将消息发送到消息队列的 **尾端** （入队）
///
/// + 当消息队列中没有可用的消息槽可用时，立即返回 [`XwmqError::NoSlot`] 。
/// + 当消息队列中有可用的消息槽时，取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
///
/// # 上下文
///
/// + 任意
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NoSlot`] 消息队列中没有可用的消息槽
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.tryeq("message".to_string());
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn tryeq(&self, data: T) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_tryeq(self.xwmq.mq.get(), 0, raw as *mut c_void);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -ENODATA == rc {
XwmqError::NoSlot(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
/// 等待消息槽，成功后将消息发送到消息队列的 **首端** （插队）
///
/// + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
/// + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
/// + 当发送线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.jq("message".to_string());
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn jq(&self, data: T) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_jq(self.xwmq.mq.get(), 0, raw as *mut c_void);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -EINTR == rc {
XwmqError::Interrupt(rc)
} else if -ENOTTHDCTX == rc {
XwmqError::NotThreadContext(rc)
} else if -EDISPMPT == rc {
XwmqError::DisPmpt(rc)
} else if -EDISBH == rc {
XwmqError::DisBh(rc)
} else if -EDISIRQ == rc {
XwmqError::DisIrq(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
/// 限时等待消息槽，成功后将消息发送到消息队列的 **首端** （插队）
///
/// + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待，等待时会指定一个唤醒时间点。
/// + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
/// + 当发送线程阻塞等待被中断时，返回 [`XwmqError::Interrupt`] 。
/// + 当到达指定的唤醒时间点，线程被唤醒，并返回 [`XwmqError::Timedout`] 。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
/// + to: 期望唤醒的时间点
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::Timedout`] 等待超时
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwtm;
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.jq_to("message".to_string(), xwtm::ft(xwtm::s(1)));
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn jq_to(&self, data: T, to: XwTm) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_jq_to(self.xwmq.mq.get(), 0, raw as *mut c_void, to);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -EINTR == rc {
XwmqError::Interrupt(rc)
} else if -ETIMEDOUT == rc {
XwmqError::Timedout(rc)
} else if -ENOTTHDCTX == rc {
XwmqError::NotThreadContext(rc)
} else if -EDISPMPT == rc {
XwmqError::DisPmpt(rc)
} else if -EDISBH == rc {
XwmqError::DisBh(rc)
} else if -EDISIRQ == rc {
XwmqError::DisIrq(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
/// 等待消息槽，且等待不可被中断，成功后将消息发送到消息队列的 **首端** （插队）
///
/// + 当消息队列中没有可用的消息槽可用时，发送线程会阻塞等待。
/// + 发送线程的阻塞等待不可被中断。
/// + 当消息队列中有可用的消息槽时，发送线程被唤醒，并取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.jq_unintr("message".to_string());
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn jq_unintr(&self, data: T) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_jq_unintr(self.xwmq.mq.get(), 0, raw as *mut c_void);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -ENOTTHDCTX == rc {
XwmqError::NotThreadContext(rc)
} else if -EDISPMPT == rc {
XwmqError::DisPmpt(rc)
} else if -EDISBH == rc {
XwmqError::DisBh(rc)
} else if -EDISIRQ == rc {
XwmqError::DisIrq(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
/// 尝试获取消息槽，成功后将消息发送到消息队列的 **首端** （插队）
///
/// + 当消息队列中没有可用的消息槽可用时，立即返回 [`XwmqError::NoSlot`] 。
/// + 当消息队列中有可用的消息槽时，取走一个消息槽，用于发送数据。
/// + 消息 **入队** 时，会通过 [`Box`] 将数据放入heap中，然后进行发送。
///
/// # 参数说明
///
/// + data: 类型为 `T` 的数据
///
/// # 上下文
///
/// + 任意
///
/// # 错误码
///
/// + [`XwmqError::Ok`] 没有错误
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NoSlot`] 消息队列中没有可用的消息槽
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// tx.tryjq("message".to_string());
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
pub fn tryjq(&self, data: T) -> XwmqError {
let boxdata = Box::new(data);
let raw = Box::into_raw(boxdata);
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
rc = xwmq_tryjq(self.xwmq.mq.get(), 0, raw as *mut c_void);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
XwmqError::Ok(rc)
} else if -ENODATA == rc {
XwmqError::NoSlot(rc)
} else {
XwmqError::Unknown(rc)
}
} else {
XwmqError::NotInit(rc)
}
}
}
}
impl<'a, const N: XwSz, T> XwmqRx<'a, N, T>
where
[u8; N * SIZEOF_XWMQ_MSG]: Sized
{
/// 等待从消息队列 **首端** 接收一条消息
///
/// + 从消息队列的 **首端** 取出消息，称为 **离队** 。
/// + 当消息队列中没有消息时，接收线程会阻塞等待。
/// + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
/// + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.dq();
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn dq(&self) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_dq(self.xwmq.mq.get(), &mut topic, &mut raw);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -EINTR == rc {
Err(XwmqError::Interrupt(rc))
} else if -ENOTTHDCTX == rc {
Err(XwmqError::NotThreadContext(rc))
} else if -EDISPMPT == rc {
Err(XwmqError::DisPmpt(rc))
} else if -EDISBH == rc {
Err(XwmqError::DisBh(rc))
} else if -EDISIRQ == rc {
Err(XwmqError::DisIrq(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
/// 限时等待从消息队列 **首端** 接收一条消息
///
/// + 从消息队列的 **首端** 取出消息，称为 **离队** 。
/// + 当消息队列中没有消息时，接收线程会阻塞等待，等待时会指定一个唤醒时间点。
/// + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
/// + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
/// + 当到达指定的唤醒时间点，线程被唤醒，并通过 [`Err()`] 返回 [`XwmqError::Timedout`] 。
///
/// # 参数说明
///
/// + to: 期望唤醒的时间点
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::Timedout`] 等待超时
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwtm;
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.dq_to(xwtm::ft(xwtm::s(1)));
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn dq_to(&self, to: XwTm) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_dq_to(self.xwmq.mq.get(), &mut topic, &mut raw, to);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -EINTR == rc {
Err(XwmqError::Interrupt(rc))
} else if -ETIMEDOUT == rc {
Err(XwmqError::Timedout(rc))
} else if -ENOTTHDCTX == rc {
Err(XwmqError::NotThreadContext(rc))
} else if -EDISPMPT == rc {
Err(XwmqError::DisPmpt(rc))
} else if -EDISBH == rc {
Err(XwmqError::DisBh(rc))
} else if -EDISIRQ == rc {
Err(XwmqError::DisIrq(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
/// 等待从消息队列 **首端** 接收一条消息，且等待不可被中断
///
/// + 从消息队列的 **首端** 取出消息，称为 **离队** 。
/// + 当消息队列中没有消息时，接收线程会阻塞等待。
/// + 接收线程的阻塞等待不可被中断。
/// + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.dq();
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn dq_unintr(&self) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_dq_unintr(self.xwmq.mq.get(), &mut topic, &mut raw);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -ENOTTHDCTX == rc {
Err(XwmqError::NotThreadContext(rc))
} else if -EDISPMPT == rc {
Err(XwmqError::DisPmpt(rc))
} else if -EDISBH == rc {
Err(XwmqError::DisBh(rc))
} else if -EDISIRQ == rc {
Err(XwmqError::DisIrq(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
/// 尝试从消息队列 **首端** 接收一条消息
///
/// + 从消息队列的 **首端** 取出消息，称为 **离队** 。
/// + 当消息队列中没有消息时，立即通过 [`Err()`] 返回 [`XwmqError::NoMsg`] 。
/// + 当消息队列中有可用的消息时，会取走一个消息，并释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
///
/// # 上下文
///
/// + 任意
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NoMsg`] 消息队列中没有消息
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.trydq();
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn trydq(&self) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_trydq(self.xwmq.mq.get(), &mut topic, &mut raw);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -ENODATA == rc {
Err(XwmqError::NoMsg(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
/// 等待从消息队列 **尾端** 接收一条消息
///
/// + 从消息队列的 **尾端** 取出消息，称为 **反向离队** 。
/// + 当消息队列中没有消息时，接收线程会阻塞等待。
/// + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
/// + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.rq();
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn rq(&self) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_rq(self.xwmq.mq.get(), &mut topic, &mut raw);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -EINTR == rc {
Err(XwmqError::Interrupt(rc))
} else if -ENOTTHDCTX == rc {
Err(XwmqError::NotThreadContext(rc))
} else if -EDISPMPT == rc {
Err(XwmqError::DisPmpt(rc))
} else if -EDISBH == rc {
Err(XwmqError::DisBh(rc))
} else if -EDISIRQ == rc {
Err(XwmqError::DisIrq(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
/// 限时等待从消息队列 **尾端** 接收一条消息
///
/// + 从消息队列的 **尾端** 取出消息，称为 **反向离队** 。
/// + 当消息队列中没有消息时，接收线程会阻塞等待，等待时会指定一个唤醒时间点。
/// + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
/// + 当线程阻塞等待被中断时，通过 [`Err()`] 返回 [`XwmqError::Interrupt`] 。
/// + 当到达指定的唤醒时间点，线程被唤醒，并通过 [`Err()`] 返回 [`XwmqError::Timedout`] 。
///
/// # 参数说明
///
/// + to: 期望唤醒的时间点
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::Interrupt`] 等待被中断
/// + [`XwmqError::Timedout`] 等待超时
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwtm;
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.rq_to(xwtm::ft(xwtm::s(1)));
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn rq_to(&self, to: XwTm) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_rq_to(self.xwmq.mq.get(), &mut topic, &mut raw, to);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -EINTR == rc {
Err(XwmqError::Interrupt(rc))
} else if -ETIMEDOUT == rc {
Err(XwmqError::Timedout(rc))
} else if -ENOTTHDCTX == rc {
Err(XwmqError::NotThreadContext(rc))
} else if -EDISPMPT == rc {
Err(XwmqError::DisPmpt(rc))
} else if -EDISBH == rc {
Err(XwmqError::DisBh(rc))
} else if -EDISIRQ == rc {
Err(XwmqError::DisIrq(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
/// 等待从消息队列 **尾端** 接收一条消息，且等待不可被中断
///
/// + 从消息队列的 **尾端** 取出消息，称为 **反向离队** 。
/// + 当消息队列中没有消息时，接收线程会阻塞等待。
/// + 接收线程的阻塞等待不可被中断。
/// + 当消息队列中有可用的消息时，接收线程被唤醒，并取走一个消息，释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NotThreadContext`] 不在线程上下文内
/// + [`XwmqError::DisPmpt`] 抢占被关闭
/// + [`XwmqError::DisBh`] 中断底半部被关闭
/// + [`XwmqError::DisIrq`] 中断被关闭
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.rq();
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn rq_unintr(&self) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_rq_unintr(self.xwmq.mq.get(), &mut topic, &mut raw);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -ENOTTHDCTX == rc {
Err(XwmqError::NotThreadContext(rc))
} else if -EDISPMPT == rc {
Err(XwmqError::DisPmpt(rc))
} else if -EDISBH == rc {
Err(XwmqError::DisBh(rc))
} else if -EDISIRQ == rc {
Err(XwmqError::DisIrq(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
/// 尝试从消息队列 **尾端** 接收一条消息
///
/// + 从消息队列的 **尾端** 取出消息，称为 **反向离队** 。
/// + 当消息队列中没有消息时，立即通过 [`Err()`] 返回 [`XwmqError::NoMsg`] 。
/// + 当消息队列中有可用的消息时，会取走一个消息，并释放消息槽。
/// 若有发送线程正在等待消息槽，将唤醒发送线程。
/// + 消息 **离队** 时，会通过 [`Box::from_raw()`] 将数据重新放入 [`Box`] 中，然后通过 [`Ok()`] 返回。
///
/// # 上下文
///
/// + 任意
///
/// # 错误码
///
/// + [`XwmqError::NotInit`] 消息队列没有初始化
/// + [`XwmqError::NoMsg`] 消息队列中没有消息
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::string::String;
/// use alloc::string::ToString;
///
/// use xwrust::xwmd::xwmq::*;
///
/// static MQ: Xwmq<16, String> = Xwmq::new();
///
/// pub fn xwrust_example_xwmq() {
/// let (tx, rx) = MQ.init();
/// // ...省略...
/// let rc = rx.tryrq();
/// match rc {
/// Ok(d) => { // d是Box<String>
/// },
/// Err(e) => { // e是错误码
/// },
/// };
/// // ...省略...
/// }
/// ```
///
/// [`Box`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html>
/// [`Box::from_raw()`]: <https://doc.rust-lang.org/alloc/boxed/struct.Box.html#method.from_raw>
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
pub fn tryrq(&self) -> Result<Box<T>, XwmqError> {
unsafe {
let mut rc = xwrustffi_xwmq_acquire(self.xwmq.mq.get(), *self.xwmq.tik.get());
if rc == 0 {
let mut topic = 0;
let mut raw: *mut c_void = ptr::null_mut();
rc = xwmq_tryrq(self.xwmq.mq.get(), &mut topic, &mut raw);
xwmq_put(self.xwmq.mq.get());
if XWOK == rc {
let boxdata = Box::from_raw(raw as *mut T);
Ok(boxdata)
} else if -ENODATA == rc {
Err(XwmqError::NoMsg(rc))
} else {
Err(XwmqError::Unknown(rc))
}
} else {
Err(XwmqError::NotInit(rc))
}
}
}
}