File size: 59,764 Bytes
8c763fb | 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
using System.Management.Automation.Internal;
using System.Management.Automation.Remoting;
using System.Management.Automation.Remoting.Internal;
using System.Management.Automation.Runspaces;
using System.Management.Automation.Tracing;
using System.Threading;
using Dbg = System.Management.Automation.Diagnostics;
// Stops compiler from warning about unknown warnings
#pragma warning disable 1634, 1691
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// Cmdlet used for receiving results from job object.
/// This cmdlet is intended to have a slightly different behavior
/// in the following two cases:
/// 1. The job object to receive results from is a PSRemotingJob
/// In this case, the cmdlet can use two additional
/// parameters to filter results - ComputerName and Runspace
/// The parameters help filter out results for a specified
/// computer or runspace from the job object
///
/// $job = Start-PSJob -Command 'get-process' -ComputerName server1, server2
/// Receive-PSJob -Job $job -ComputerName server1
///
/// $job = Start-PSJob -Command 'get-process' -Session $r1, $r2
/// Receive-PSJob -Job $job -Session $r1
///
/// 2. The job object to receive results is a PSJob (or derivative
/// other than PSRemotingJob)
/// In this case, the user cannot will use the location parameter
/// to do any filtering and will not have ComputerName and Runspace
/// parameters
///
/// $job = Get-WMIObject '....' -AsJob
/// Receive-PSJob -Job $job -Location "Server2"
///
/// The following will result in an error:
///
/// $job = Get-WMIObject '....' -AsJob
/// Receive-PSJob -Job $job -ComputerName "Server2"
/// The parameter ComputerName cannot be used with jobs which are
/// not PSRemotingJob.
/// </summary>
[Cmdlet(VerbsCommunications.Receive, "Job", DefaultParameterSetName = ReceiveJobCommand.LocationParameterSet,
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096965", RemotingCapability = RemotingCapability.SupportedByCommand)]
public class ReceiveJobCommand : JobCmdletBase, IDisposable
{
#region Properties
/// <summary>
/// Job object from which specific results need to
/// be extracted.
/// </summary>
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceiveJobCommand.ComputerNameParameterSet)]
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceiveJobCommand.SessionParameterSet)]
[Parameter(Position = 0,
Mandatory = true,
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceiveJobCommand.LocationParameterSet)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public Job[] Job
{
get
{
return _jobs;
}
set
{
_jobs = value;
}
}
private Job[] _jobs;
/// <summary>
/// Name of the computer for which the results needs to be
/// returned.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceiveJobCommand.ComputerNameParameterSet,
Position = 1)]
[Alias("Cn")]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[ValidateNotNullOrEmpty]
public string[] ComputerName
{
get
{
return _computerNames;
}
set
{
_computerNames = value;
}
}
private string[] _computerNames;
/// <summary>
/// Locations for which the results needs to be returned.
/// This will cater to all kinds of jobs and not only
/// remoting jobs.
/// </summary>
[Parameter(ParameterSetName = ReceiveJobCommand.LocationParameterSet,
Position = 1)]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Location
{
get
{
return _locations;
}
set
{
_locations = value;
}
}
private string[] _locations;
/// <summary>
/// Runspaces for which the results needs to be
/// returned.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = ReceiveJobCommand.SessionParameterSet,
Position = 1)]
[ValidateNotNull]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public PSSession[] Session
{
get
{
return _remoteRunspaceInfos;
}
set
{
_remoteRunspaceInfos = value;
}
}
private PSSession[] _remoteRunspaceInfos;
/// <summary>
/// If the results need to be not removed from the store
/// after being written. Default is results are removed.
/// </summary>
[Parameter]
public SwitchParameter Keep
{
get
{
return !_flush;
}
set
{
_flush = !value;
ValidateWait();
}
}
private bool _flush = true;
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter NoRecurse
{
get
{
return !_recurse;
}
set
{
_recurse = !value;
}
}
private bool _recurse = true;
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter Force
{ get; set; }
/// <summary>
/// </summary>
public override JobState State
{
get
{
return JobState.NotStarted;
}
}
/// <summary>
/// </summary>
public override Hashtable Filter
{
get { return null; }
}
/// <summary>
/// </summary>
public override string[] Command
{
get
{
return null;
}
}
/// <summary>
/// </summary>
protected const string LocationParameterSet = "Location";
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter Wait
{
get
{
return _wait;
}
set
{
_wait = value;
ValidateWait();
}
}
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter AutoRemoveJob
{
get
{
return _autoRemoveJob;
}
set
{
_autoRemoveJob = value;
}
}
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter WriteEvents
{
get
{
return _writeStateChangedEvents;
}
set
{
_writeStateChangedEvents = value;
}
}
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter WriteJobInResults
{
get
{
return _outputJobFirst;
}
set
{
_outputJobFirst = value;
}
}
private bool _autoRemoveJob;
private bool _writeStateChangedEvents;
private bool _wait;
private bool _isStopping;
private bool _isDisposed;
private readonly ReaderWriterLockSlim _resultsReaderWriterLock = new ReaderWriterLockSlim();
private readonly PowerShellTraceSource _tracer = PowerShellTraceSourceFactory.GetTraceSource();
private readonly ManualResetEvent _writeExistingData = new ManualResetEvent(true);
private readonly PSDataCollection<PSStreamObject> _results = new PSDataCollection<PSStreamObject>();
private bool _holdingResultsRef;
private readonly List<Job> _jobsBeingAggregated = new List<Job>();
private readonly List<Guid> _jobsSpecifiedInParameters = new List<Guid>();
private readonly object _syncObject = new object();
private bool _outputJobFirst;
private OutputProcessingState _outputProcessingNotification;
private bool _processingOutput;
private const string ClassNameTrace = "ReceiveJobCommand";
#endregion Properties
#region Overrides
/// <summary>
/// </summary>
protected override void BeginProcessing()
{
ValidateAutoRemove();
ValidateWriteJobInResults();
ValidateWriteEvents();
ValidateForce();
}
/// <summary>
/// Retrieve the results for the specified computers or
/// runspaces.
/// </summary>
protected override void ProcessRecord()
{
bool checkForRecurse = false;
List<Job> jobsToWrite = new List<Job>();
switch (ParameterSetName)
{
case SessionParameterSet:
{
foreach (Job job in _jobs)
{
PSRemotingJob remoteJob =
job as PSRemotingJob;
if (remoteJob == null)
{
string message = GetMessage(RemotingErrorIdStrings.RunspaceParamNotSupported);
WriteError(new ErrorRecord(new ArgumentException(message),
"RunspaceParameterNotSupported", ErrorCategory.InvalidArgument,
job));
continue;
}
// Runspace parameter is supported only on PSRemotingJob objects
foreach (PSSession remoteRunspaceInfo in _remoteRunspaceInfos)
{
// get the required child jobs
List<Job> childJobs = remoteJob.GetJobsForRunspace(remoteRunspaceInfo);
jobsToWrite.AddRange(childJobs);
// WriteResultsForJobsInCollection(childJobs, false);
}
}
}
break;
case ComputerNameParameterSet:
{
foreach (Job job in _jobs)
{
// the job can either be a remoting job or another one
PSRemotingJob remoteJob =
job as PSRemotingJob;
// ComputerName parameter can only be used with remoting jobs
if (remoteJob == null)
{
string message = GetMessage(RemotingErrorIdStrings.ComputerNameParamNotSupported);
WriteError(new ErrorRecord(new ArgumentException(message),
"ComputerNameParameterNotSupported", ErrorCategory.InvalidArgument,
job));
continue;
}
string[] resolvedComputernames = null;
ResolveComputerNames(_computerNames, out resolvedComputernames);
foreach (string resolvedComputerName in resolvedComputernames)
{
// get the required child Job objects
List<Job> childJobs = remoteJob.GetJobsForComputer(resolvedComputerName);
jobsToWrite.AddRange(childJobs);
// WriteResultsForJobsInCollection(childJobs, false);
}
}
}
break;
case "Location":
{
if (_locations == null)
{
// WriteAll();
jobsToWrite.AddRange(_jobs);
checkForRecurse = true;
}
else
{
foreach (Job job in _jobs)
{
foreach (string location in _locations)
{
// get the required child Job objects
List<Job> childJobs = job.GetJobsForLocation(location);
jobsToWrite.AddRange(childJobs);
// WriteResultsForJobsInCollection(childJobs, false);
}
}
}
}
break;
case ReceiveJobCommand.InstanceIdParameterSet:
{
List<Job> jobs = FindJobsMatchingByInstanceId(true, false, true, false);
jobsToWrite.AddRange(jobs);
checkForRecurse = true;
// WriteResultsForJobsInCollection(jobs, true);
}
break;
case ReceiveJobCommand.SessionIdParameterSet:
{
List<Job> jobs = FindJobsMatchingBySessionId(true, false, true, false);
jobsToWrite.AddRange(jobs);
checkForRecurse = true;
// WriteResultsForJobsInCollection(jobs, true);
}
break;
case ReceiveJobCommand.NameParameterSet:
{
List<Job> jobs = FindJobsMatchingByName(true, false, true, false);
jobsToWrite.AddRange(jobs);
checkForRecurse = true;
// WriteResultsForJobsInCollection(jobs, true);
}
break;
}
// if block has been specified and the cmdlet has not been
// stopped, we continue to write recursively, until there
// is no more data to write
if (_wait)
{
_writeExistingData.Reset();
// if writejobresults is specified we will write only the top level jobs
// this is because that is what the proxy requires. Anything else being
// written is useless and will only add weight to the serialization
WriteJobsIfRequired(jobsToWrite);
// Make a note of the jobs specified by the user (does not include child jobs)
// for the purpose of removal. Only the parent jobs should have remove called.
foreach (var job in jobsToWrite)
{
_jobsSpecifiedInParameters.Add(job.InstanceId);
}
lock (_syncObject)
{
if (_isDisposed || _isStopping) return;
// Check to see that we only AddRef once. ProcessRecord is called
// once per job on the pipeline.
if (!_holdingResultsRef)
{
_tracer.WriteMessage(ClassNameTrace, "ProcessRecord", Guid.Empty, (Job)null, "Adding Ref to results collection",
null);
_results.AddRef();
_holdingResultsRef = true;
}
}
_tracer.WriteMessage(ClassNameTrace, "ProcessRecord", Guid.Empty, (Job)null, "BEGIN Register for jobs");
WriteResultsForJobsInCollection(jobsToWrite, checkForRecurse, true);
_tracer.WriteMessage(ClassNameTrace, "ProcessRecord", Guid.Empty, (Job)null, "END Register for jobs");
lock (_syncObject)
{
if (_jobsBeingAggregated.Count == 0 && _holdingResultsRef)
{
_tracer.WriteMessage(ClassNameTrace, "ProcessRecord", Guid.Empty, (Job)null,
"Removing Ref to results collection", null);
_results.DecrementRef();
_holdingResultsRef = false;
}
}
_tracer.WriteMessage(ClassNameTrace, "ProcessRecord", Guid.Empty, (Job)null, "BEGIN Write existing job data");
WriteResultsForJobsInCollection(jobsToWrite, checkForRecurse, false);
_tracer.WriteMessage(ClassNameTrace, "ProcessRecord", Guid.Empty, (Job)null, "END Write existing job data");
_writeExistingData.Set();
}
else
{
WriteResultsForJobsInCollection(jobsToWrite, checkForRecurse, false);
}
}
/// <summary>
/// StopProcessing - when the command is stopped,
/// unregister all the event handlers from the jobs
/// and decrement reference for results.
/// </summary>
protected override void StopProcessing()
{
_tracer.WriteMessage(ClassNameTrace, "StopProcessing", Guid.Empty, (Job)null, "Entered Stop Processing",
null);
lock (_syncObject)
{
_isStopping = true;
}
_writeExistingData.Set();
Job[] aggregatedJobs = new Job[_jobsBeingAggregated.Count];
for (int i = 0; i < _jobsBeingAggregated.Count; i++)
{
aggregatedJobs[i] = _jobsBeingAggregated[i];
}
foreach (Job job in aggregatedJobs)
{
StopAggregateResultsFromJob(job);
}
_resultsReaderWriterLock.EnterWriteLock();
try
{
_results.Complete();
SetOutputProcessingState(false);
}
finally
{
_resultsReaderWriterLock.ExitWriteLock();
}
base.StopProcessing();
_tracer.WriteMessage(ClassNameTrace, "StopProcessing", Guid.Empty, (Job)null, "Exiting Stop Processing",
null);
}
/// <summary>
/// If we are not stopping, continue writing output
/// as and when they are available.
/// </summary>
protected override void EndProcessing()
{
try
{
if (_wait)
{
int totalCount = 0;
foreach (PSStreamObject result in _results)
{
if (_isStopping) break;
SetOutputProcessingState(true);
result.WriteStreamObject(this, true, true);
if (++totalCount == _results.Count)
{
SetOutputProcessingState(false);
}
}
_eventArgsWritten.Clear();
}
else
{
int totalCount = 0;
foreach (PSStreamObject result in _results)
{
if (_isStopping) break;
SetOutputProcessingState(true);
result.WriteStreamObject(this, false, true);
if (++totalCount == _results.Count)
{
SetOutputProcessingState(false);
}
}
}
}
finally
{
SetOutputProcessingState(false);
}
}
/// <summary>
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// </summary>
/// <param name="disposing"></param>
protected void Dispose(bool disposing)
{
if (disposing)
{
if (_isDisposed) return;
lock (_syncObject)
{
if (_isDisposed) return;
_isDisposed = true;
}
SetOutputProcessingState(false);
if (_jobsBeingAggregated != null)
{
foreach (var job in _jobsBeingAggregated)
{
if (job.MonitorOutputProcessing)
{
job.RemoveMonitorOutputProcessing(_outputProcessingNotification);
}
if (job.UsesResultsCollection)
{
job.Results.DataAdded -= ResultsAdded;
}
else
{
job.Output.DataAdded -= Output_DataAdded;
job.Error.DataAdded -= Error_DataAdded;
job.Progress.DataAdded -= Progress_DataAdded;
job.Verbose.DataAdded -= Verbose_DataAdded;
job.Warning.DataAdded -= Warning_DataAdded;
job.Debug.DataAdded -= Debug_DataAdded;
job.Information.DataAdded -= Information_DataAdded;
}
job.StateChanged -= HandleJobStateChanged;
}
}
_resultsReaderWriterLock.EnterWriteLock();
try
{
_results.Complete();
}
finally
{
_resultsReaderWriterLock.ExitWriteLock();
}
_resultsReaderWriterLock.Dispose();
_results.Clear();
_results.Dispose();
_writeExistingData.Set();
_writeExistingData.Dispose();
}
}
#endregion Overrides
#region Private Methods
private static void DoUnblockJob(Job job)
{
// we should not do anything for a parent job
// the assumption is parent job states are
// computed and so unblocking the child state
// should be able to handle this
if (job.ChildJobs.Count != 0) return;
// we have a better way of handling blocked state logic
// for remoting jobs, so use that if job is a remoting
// job
PSRemotingChildJob remotingChildJob = job as PSRemotingChildJob;
if (remotingChildJob != null)
{
remotingChildJob.UnblockJob();
}
else
{
// for all other job types, simply set the job state
// to running, the handling of the parent jobs state
// should be taken care of by the job implementation
job.SetJobState(JobState.Running, null);
}
}
/// <summary>
/// Write the results from this Job object. This does not write from the
/// child jobs of this job object.
/// </summary>
/// <param name="job">Job object from which to write the results from
/// </param>
private void WriteJobResults(Job job)
{
if (job == null) return;
// Q: Why do we need to unblock the job, before getting
// the results
// A: The job can get into a terminal state and we do
// not want to set it to running at that point. Also, if
// we do not explicitly signal that the job is unblocked
// then the parent job cannot be unblocked. This is because
// the parent job does not maintain a list of jobs which
// are blocked but just simply a count (to keep things
// light weight)
// check if the state of the job is blocked, if so unblock it
// Skip disconnected jobs that were in Blocked state before
// the disconnect, since we cannot process host data until the
// job is re-connected.
if (job.JobStateInfo.State == JobState.Disconnected)
{
PSRemotingChildJob remotingChildJob = job as PSRemotingChildJob;
if (remotingChildJob != null && remotingChildJob.DisconnectedAndBlocked)
{
return;
}
}
// TODO: Fix Unblock() handling by Job2
if (job.JobStateInfo.State == JobState.Blocked)
{
DoUnblockJob(job);
}
// for the jobs that PowerShell writes, there is a
// results collection internally used. This collection
// can be used to write results. For all other jobs
// results need to be written from the other collections
// available.
// There is a bug in V2 that only remoting jobs work
// with Receive-Job. This is being fixed
if (job is not Job2 && job.UsesResultsCollection)
{
// extract results and handle them
Collection<PSStreamObject> results = ReadAll<PSStreamObject>(job.Results);
if (_wait)
{
foreach (var psStreamObject in results)
{
psStreamObject.WriteStreamObject(this, job.Results.SourceId);
}
}
else
{
foreach (var psStreamObject in results)
{
psStreamObject.WriteStreamObject(this);
}
}
}
else
{
Collection<PSObject> output = ReadAll<PSObject>(job.Output);
foreach (PSObject o in output)
{
if (o == null) continue;
WriteObject(o);
}
Collection<ErrorRecord> errorRecords = ReadAll<ErrorRecord>(job.Error);
foreach (ErrorRecord e in errorRecords)
{
if (e == null) continue;
MshCommandRuntime mshCommandRuntime = CommandRuntime as MshCommandRuntime;
if (mshCommandRuntime != null)
{
e.PreserveInvocationInfoOnce = true;
mshCommandRuntime.WriteError(e, true);
}
}
Collection<VerboseRecord> verboseRecords = ReadAll(job.Verbose);
foreach (VerboseRecord v in verboseRecords)
{
if (v == null) continue;
MshCommandRuntime mshCommandRuntime = CommandRuntime as MshCommandRuntime;
mshCommandRuntime?.WriteVerbose(v, true);
}
Collection<DebugRecord> debugRecords = ReadAll(job.Debug);
foreach (DebugRecord d in debugRecords)
{
if (d == null) continue;
MshCommandRuntime mshCommandRuntime = CommandRuntime as MshCommandRuntime;
mshCommandRuntime?.WriteDebug(d, true);
}
Collection<WarningRecord> warningRecords = ReadAll(job.Warning);
foreach (WarningRecord w in warningRecords)
{
if (w == null) continue;
MshCommandRuntime mshCommandRuntime = CommandRuntime as MshCommandRuntime;
mshCommandRuntime?.WriteWarning(w, true);
}
Collection<ProgressRecord> progressRecords = ReadAll(job.Progress);
foreach (ProgressRecord p in progressRecords)
{
if (p == null) continue;
MshCommandRuntime mshCommandRuntime = CommandRuntime as MshCommandRuntime;
mshCommandRuntime?.WriteProgress(p, true);
}
Collection<InformationRecord> informationRecords = ReadAll(job.Information);
foreach (InformationRecord p in informationRecords)
{
if (p == null) continue;
MshCommandRuntime mshCommandRuntime = CommandRuntime as MshCommandRuntime;
mshCommandRuntime?.WriteInformation(p, true);
}
}
if (job.JobStateInfo.State != JobState.Failed) return;
WriteReasonError(job);
}
private void WriteReasonError(Job job)
{
// Write better error for the remoting case and generic error for the other case
PSRemotingChildJob child = job as PSRemotingChildJob;
if (child != null && child.FailureErrorRecord != null)
{
_results.Add(new PSStreamObject(PSStreamObjectType.Error, child.FailureErrorRecord, child.InstanceId));
}
else if (job.JobStateInfo.Reason != null)
{
Exception baseReason = job.JobStateInfo.Reason;
Exception resultReason = baseReason;
// If it was generated by a job that gave location information, unpack the
// base exception.
JobFailedException exceptionWithLocation = baseReason as JobFailedException;
if (exceptionWithLocation != null)
{
resultReason = exceptionWithLocation.Reason;
}
ErrorRecord errorRecord = new ErrorRecord(resultReason, "JobStateFailed", ErrorCategory.InvalidResult, null);
// If it was generated by a job that gave location information, set the
// location information.
if ((exceptionWithLocation != null) && (exceptionWithLocation.DisplayScriptPosition != null))
{
if (errorRecord.InvocationInfo == null)
{
errorRecord.SetInvocationInfo(new InvocationInfo(null, null));
}
errorRecord.InvocationInfo.DisplayScriptPosition = exceptionWithLocation.DisplayScriptPosition;
}
_results.Add(new PSStreamObject(PSStreamObjectType.Error, errorRecord, job.InstanceId));
}
}
/// <summary>
/// Returns all the results from supplied PSDataCollection.
/// </summary>
/// <param name="psDataCollection">Data collection to read from.</param>
/// <returns>Collection with copy of data.</returns>
private Collection<T> ReadAll<T>(PSDataCollection<T> psDataCollection)
{
if (_flush)
{
return psDataCollection.ReadAll();
}
T[] array = new T[psDataCollection.Count];
psDataCollection.CopyTo(array, 0);
Collection<T> collection = new Collection<T>();
foreach (T t in array)
{
collection.Add(t);
}
return collection;
}
/// <summary>
/// Write the results from this Job object. It also writes the
/// results from its child objects recursively.
/// </summary>
/// <param name="duplicate">Hashtable used for duplicate detection.</param>
/// <param name="job">Job whose results are written.</param>
/// <param name="registerInsteadOfWrite"></param>
private void WriteJobResultsRecursivelyHelper(Hashtable duplicate, Job job, bool registerInsteadOfWrite)
{
// Check if this object is already visited. If not, add it to the cache
if (duplicate.ContainsKey(job))
{
return;
}
duplicate.Add(job, job);
// Write the results of child jobs
IList<Job> childJobs = job.ChildJobs;
foreach (Job childjob in childJobs)
{
WriteJobResultsRecursivelyHelper(duplicate, childjob, registerInsteadOfWrite);
}
if (registerInsteadOfWrite)
{
// at any point there will be only one thread which will have
// access to an entry corresponding to a job
// this is because of the way the synchronization happens
// with the pipeline thread and event handler thread using
// _writeExistingData
_eventArgsWritten[job.InstanceId] = false;
// register the job for future updates
AggregateResultsFromJob(job);
}
else
{
// Write the results of this job
WriteJobResults(job);
WriteJobStateInformationIfRequired(job);
}
}
/// <summary>
/// Writes the job objects if required by the cmdlet.
/// </summary>
/// <param name="jobsToWrite">Collection of jobs to write.</param>
/// <remarks>this method is intended to be called only from
/// ProcessRecord. When any changes are made ensure that this
/// contract is not broken</remarks>
private void WriteJobsIfRequired(IEnumerable<Job> jobsToWrite)
{
if (!_outputJobFirst) return;
foreach (var job in jobsToWrite)
{
_tracer.WriteMessage("ReceiveJobCommand", "WriteJobsIfRequired", Guid.Empty, job, "Writing job object as output", null);
WriteObject(job);
}
}
/// <summary>
/// </summary>
/// <param name="job"></param>
/// <remarks>this method should always be called before
/// writeExistingData is set in ProcessRecord</remarks>
private void AggregateResultsFromJob(Job job)
{
if ((!Force && job.IsPersistentState(job.JobStateInfo.State)) || (Force && job.IsFinishedState(job.JobStateInfo.State))) return;
job.StateChanged += HandleJobStateChanged;
// Check after the state changed event has been subscribed to avoid a race
// with the job state. StopAggregate is called from the state changed handler, so-
// this could cause the job to never be removed from _jobsBeingAggregated
// and therefore the _results ref to never be decremented.
if ((!Force && job.IsPersistentState(job.JobStateInfo.State)) || (Force && job.IsFinishedState(job.JobStateInfo.State)))
{
job.StateChanged -= HandleJobStateChanged;
return;
}
_tracer.WriteMessage(ClassNameTrace, "AggregateResultsFromJob", Guid.Empty, job,
"BEGIN Adding job for aggregation", null);
// at this point, we can be sure that any job added to this
// collection will have a state changed event to a finished state.
_jobsBeingAggregated.Add(job);
// Tag the output collection so that the instance ID can be added to the output objects when streaming.
if (job.UsesResultsCollection)
{
job.Results.SourceId = job.InstanceId;
job.Results.DataAdded += ResultsAdded;
}
else
{
job.Output.SourceId = job.InstanceId;
job.Error.SourceId = job.InstanceId;
job.Progress.SourceId = job.InstanceId;
job.Verbose.SourceId = job.InstanceId;
job.Warning.SourceId = job.InstanceId;
job.Debug.SourceId = job.InstanceId;
job.Information.SourceId = job.InstanceId;
job.Output.DataAdded += Output_DataAdded;
job.Error.DataAdded += Error_DataAdded;
job.Progress.DataAdded += Progress_DataAdded;
job.Verbose.DataAdded += Verbose_DataAdded;
job.Warning.DataAdded += Warning_DataAdded;
job.Debug.DataAdded += Debug_DataAdded;
job.Information.DataAdded += Information_DataAdded;
}
if (job.MonitorOutputProcessing)
{
if (_outputProcessingNotification == null)
{
lock (_syncObject)
{
_outputProcessingNotification ??= new OutputProcessingState();
}
}
job.SetMonitorOutputProcessing(_outputProcessingNotification);
}
_tracer.WriteMessage(ClassNameTrace, "AggregateResultsFromJob", Guid.Empty, job,
"END Adding job for aggregation", null);
}
private void ResultsAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed) return;
}
_writeExistingData.WaitOne();
PSDataCollection<PSStreamObject> results = sender as PSDataCollection<PSStreamObject>;
Dbg.Assert(results != null, "PSDataCollection is raising an inappropriate event");
PSStreamObject record = GetData(results, e.Index);
if (record != null)
{
record.Id = results.SourceId;
_results.Add(record);
}
}
private void HandleJobStateChanged(object sender, JobStateEventArgs e)
{
Job job = sender as Job;
Dbg.Assert(job != null, "Job state info cannot be raised with reference to job");
// waiting for existing data to be written ensures two things
// 1. that no aggregation for a job is in progress
// 2. the state information is written in the correct order
// as per the contract
_tracer.WriteMessage(ClassNameTrace, "HandleJobStateChanged", Guid.Empty, job,
"BEGIN wait for write existing data", null);
if (e.JobStateInfo.State != JobState.Running)
_writeExistingData.WaitOne();
_tracer.WriteMessage(ClassNameTrace, "HandleJobStateChanged", Guid.Empty, job,
"END wait for write existing data", null);
lock (_syncObject)
{
if (!_jobsBeingAggregated.Contains(job))
{
_tracer.WriteMessage(ClassNameTrace, "HandleJobStateChanged", Guid.Empty, job,
"Returning because job is not in _jobsBeingAggregated", null);
return;
}
}
if (e.JobStateInfo.State == JobState.Blocked)
{
DoUnblockJob(job);
}
// Stop wait if:
// Force is specified and Job is in a Finished state (Completed, Failed, Stopped)
// OR
// Force is not specified and Job is in a persistent state (Suspended or
// Disconnected as well as above)
// (logic inverted for return)
if (!(!Force && job.IsPersistentState(e.JobStateInfo.State)) && !(Force && job.IsFinishedState(e.JobStateInfo.State)))
{
_tracer.WriteMessage(ClassNameTrace, "HandleJobStateChanged", Guid.Empty, job,
"Returning because job state does not meet wait requirements (continue aggregating)");
return;
}
// Write an error record with JobStateFailed ID if there is a JobStateInfo.Reason.
WriteReasonError(job);
WriteJobStateInformationIfRequired(job, e);
StopAggregateResultsFromJob(job);
}
private void Progress_DataAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed) return;
}
_writeExistingData.WaitOne();
_resultsReaderWriterLock.EnterReadLock();
try
{
if (!_results.IsOpen) return;
PSDataCollection<ProgressRecord> progressRecords = sender as PSDataCollection<ProgressRecord>;
Diagnostics.Assert(progressRecords != null, "PSDataCollection is raising an inappropriate event");
ProgressRecord record = GetData(progressRecords, e.Index);
if (record != null)
{
_results.Add(new PSStreamObject(PSStreamObjectType.Progress, record, progressRecords.SourceId));
}
}
finally
{
_resultsReaderWriterLock.ExitReadLock();
}
}
private void Error_DataAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed)
{
return;
}
}
_writeExistingData.WaitOne();
_resultsReaderWriterLock.EnterReadLock();
try
{
if (!_results.IsOpen)
{
return;
}
PSDataCollection<ErrorRecord> errorRecords = sender as PSDataCollection<ErrorRecord>;
Diagnostics.Assert(errorRecords != null, "PSDataCollection is raising an inappropriate event");
ErrorRecord errorRecord = GetData(errorRecords, e.Index);
if (errorRecord != null)
{
// error records are already tagged, skip tagging
_results.Add(new PSStreamObject(PSStreamObjectType.Error, errorRecord, Guid.Empty));
}
}
finally
{
_resultsReaderWriterLock.ExitReadLock();
}
}
private void Debug_DataAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed) return;
}
_writeExistingData.WaitOne();
_resultsReaderWriterLock.EnterReadLock();
try
{
if (!_results.IsOpen) return;
PSDataCollection<DebugRecord> debugRecords = sender as PSDataCollection<DebugRecord>;
Diagnostics.Assert(debugRecords != null, "PSDataCollection is raising an inappropriate event");
DebugRecord record = GetData(debugRecords, e.Index);
if (record != null)
{
// debug records are already tagged, skip tagging
_results.Add(new PSStreamObject(PSStreamObjectType.Debug, record.Message, Guid.Empty));
}
}
finally
{
_resultsReaderWriterLock.ExitReadLock();
}
}
private void Warning_DataAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed) return;
}
_writeExistingData.WaitOne();
_resultsReaderWriterLock.EnterReadLock();
try
{
if (!_results.IsOpen) return;
PSDataCollection<WarningRecord> warningRecords = sender as PSDataCollection<WarningRecord>;
Diagnostics.Assert(warningRecords != null, "PSDataCollection is raising an inappropriate event");
WarningRecord record = GetData(warningRecords, e.Index);
if (record != null)
{
// warning records are already tagged, skip tagging
_results.Add(new PSStreamObject(PSStreamObjectType.Warning, record.Message, Guid.Empty));
}
}
finally
{
_resultsReaderWriterLock.ExitReadLock();
}
}
private void Verbose_DataAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed) return;
}
_writeExistingData.WaitOne();
_resultsReaderWriterLock.EnterReadLock();
try
{
if (!_results.IsOpen) return;
PSDataCollection<VerboseRecord> verboseRecords = sender as PSDataCollection<VerboseRecord>;
Dbg.Assert(verboseRecords != null, "PSDataCollection is raising an inappropriate event");
VerboseRecord record = GetData(verboseRecords, e.Index);
if (record != null)
{
// verbose records are already tagged, skip tagging
_results.Add(new PSStreamObject(PSStreamObjectType.Verbose, record.Message, Guid.Empty));
}
}
finally
{
_resultsReaderWriterLock.ExitReadLock();
}
}
private void Information_DataAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed) return;
}
_writeExistingData.WaitOne();
_resultsReaderWriterLock.EnterReadLock();
try
{
if (!_results.IsOpen) return;
PSDataCollection<InformationRecord> informationRecords = sender as PSDataCollection<InformationRecord>;
Dbg.Assert(informationRecords != null, "PSDataCollection is raising an inappropriate event");
InformationRecord record = GetData(informationRecords, e.Index);
if (record != null)
{
// information records are already tagged, skip tagging
_results.Add(new PSStreamObject(PSStreamObjectType.Information, record, Guid.Empty));
}
}
finally
{
_resultsReaderWriterLock.ExitReadLock();
}
}
private void Output_DataAdded(object sender, DataAddedEventArgs e)
{
lock (_syncObject)
{
if (_isDisposed) return;
}
_writeExistingData.WaitOne();
_resultsReaderWriterLock.EnterReadLock();
try
{
if (!_results.IsOpen) return;
PSDataCollection<PSObject> output = sender as PSDataCollection<PSObject>;
Dbg.Assert(output != null, "PSDataCollection is raising an inappropriate event");
PSObject obj = GetData(output, e.Index);
if (obj != null)
{
// output objects are already tagged, skip tagging
_results.Add(new PSStreamObject(PSStreamObjectType.Output, obj, Guid.Empty));
}
}
finally
{
_resultsReaderWriterLock.ExitReadLock();
}
}
private T GetData<T>(PSDataCollection<T> collection, int index)
{
if (_flush)
{
Collection<T> data = collection.ReadAndRemove(1);
if (data.Count > 0)
{
Dbg.Assert(data.Count == 1, "DataAdded should be raised for each object added");
return data[0];
}
// it is possible that when there was a wait
// the data got written
return default(T);
}
return collection[index];
}
private void StopAggregateResultsFromJob(Job job)
{
SetOutputProcessingState(false);
lock (_syncObject)
{
_tracer.WriteMessage(ClassNameTrace, "StopAggregateResultsFromJob", Guid.Empty, job,
"Removing job from aggregation", null);
_jobsBeingAggregated.Remove(job);
if (_jobsBeingAggregated.Count == 0 && _holdingResultsRef)
{
_tracer.WriteMessage(ClassNameTrace, "StopAggregateResultsFromJob", Guid.Empty, (Job)null,
"Removing Ref to results collection", null);
_results.DecrementRef();
_holdingResultsRef = false;
}
}
if (job.MonitorOutputProcessing)
{
job.RemoveMonitorOutputProcessing(_outputProcessingNotification);
}
if (job.UsesResultsCollection)
{
job.Results.DataAdded -= ResultsAdded;
}
else
{
job.Output.DataAdded -= Output_DataAdded;
job.Error.DataAdded -= Error_DataAdded;
job.Progress.DataAdded -= Progress_DataAdded;
job.Verbose.DataAdded -= Verbose_DataAdded;
job.Warning.DataAdded -= Warning_DataAdded;
job.Debug.DataAdded -= Debug_DataAdded;
job.Information.DataAdded -= Information_DataAdded;
}
job.StateChanged -= HandleJobStateChanged;
}
private void AutoRemoveJobIfRequired(Job job)
{
if (!_autoRemoveJob) return;
if (!_jobsSpecifiedInParameters.Contains(job.InstanceId)) return;
if (!job.IsFinishedState(job.JobStateInfo.State)) return;
// Only finished jobs that were specified by the user on the cmdline
// (computed in processRecord) should reach this point.
if (job.HasMoreData)
{
_tracer.WriteMessage(ClassNameTrace, "AutoRemoveJobIfRequired", Guid.Empty, job,
"Job has data and is being removed.");
}
Job2 job2 = job as Job2;
if (job2 != null)
{
#pragma warning disable 56500
try
{
JobManager.RemoveJob(job2, this, false, true);
job.Dispose();
}
catch (Exception ex)
{
// JobSourceAdapters are third party code, and could
// throw any exception type. Catch generic exception, but transfer the error
// so that it's written to the user.
AddRemoveErrorToResults(job2, ex);
}
#pragma warning restore 56500
}
else
{
try
{
JobRepository.Remove(job);
job.Dispose();
}
catch (ArgumentException ex)
{
AddRemoveErrorToResults(job, ex);
}
}
}
private void AddRemoveErrorToResults(Job job, Exception ex)
{
var ex2 = new ArgumentException(PSRemotingErrorInvariants.FormatResourceString(RemotingErrorIdStrings.CannotRemoveJob), ex);
var removeError = new ErrorRecord(ex2, "ReceiveJobAutoRemovalError", ErrorCategory.InvalidOperation, job);
_results.Add(new PSStreamObject(PSStreamObjectType.Error, removeError));
}
/// <summary>
/// Write the results from this Job object. It also writes the
/// results from its child objects recursively.
/// </summary>
/// <param name="job">Job whose results are written.</param>
/// <param name="registerInsteadOfWrite"></param>
private void WriteJobResultsRecursively(Job job, bool registerInsteadOfWrite)
{
Hashtable duplicateDetector = new Hashtable();
WriteJobResultsRecursivelyHelper(duplicateDetector, job, registerInsteadOfWrite);
duplicateDetector.Clear();
}
/// <summary>
/// </summary>
/// <param name="jobs"></param>
/// <param name="checkForRecurse"></param>
/// <param name="registerInsteadOfWrite"></param>
private void WriteResultsForJobsInCollection(List<Job> jobs, bool checkForRecurse, bool registerInsteadOfWrite)
{
foreach (Job job in jobs)
{
if (checkForRecurse && _recurse)
{
WriteJobResultsRecursively(job, registerInsteadOfWrite);
}
else
{
if (registerInsteadOfWrite)
{
// at any point there will be only one thread which will have
// access to an entry corresponding to a job
// this is because of the way the synchronization happens
// with the pipeline thread and event handler thread using
// _writeExistingData
_eventArgsWritten[job.InstanceId] = false;
AggregateResultsFromJob(job);
}
else
{
WriteJobResults(job);
WriteJobStateInformationIfRequired(job);
}
}
}
}
private readonly Dictionary<Guid, bool> _eventArgsWritten = new Dictionary<Guid, bool>();
private void WriteJobStateInformation(Job job, JobStateEventArgs args = null)
{
// at any point there will be only one thread which will have
// access to an entry corresponding to a job
// this is because of the way the synchronization happens
// with the pipeline thread and event handler thread using
// _writeExistingData
bool eventWritten;
_eventArgsWritten.TryGetValue(job.InstanceId, out eventWritten);
if (eventWritten)
{
_tracer.WriteMessage(ClassNameTrace, "WriteJobStateInformation", Guid.Empty, job,
"State information already written, skipping another write", null);
return;
}
JobStateEventArgs eventArgs = args ?? new JobStateEventArgs(job.JobStateInfo);
_eventArgsWritten[job.InstanceId] = true;
_tracer.WriteMessage(ClassNameTrace, "WriteJobStateInformation", Guid.Empty, job, "Writing job state changed event args", null);
PSObject obj = new PSObject(eventArgs);
obj.Properties.Add(new PSNoteProperty(RemotingConstants.EventObject, true));
_results.Add(new PSStreamObject(PSStreamObjectType.Output, obj, job.InstanceId));
}
private void WriteJobStateInformationIfRequired(Job job, JobStateEventArgs args = null)
{
if (_writeStateChangedEvents && job.IsPersistentState(job.JobStateInfo.State))
{
WriteJobStateInformation(job, args);
}
AutoRemoveJobIfRequired(job);
}
private void ValidateWait()
{
if (_wait && !_flush)
{
throw PSTraceSource.NewInvalidOperationException(RemotingErrorIdStrings.BlockCannotBeUsedWithKeep);
}
}
private void ValidateWriteEvents()
{
if (_writeStateChangedEvents && !_wait)
{
throw PSTraceSource.NewInvalidOperationException(RemotingErrorIdStrings.WriteEventsCannotBeUsedWithoutWait);
}
}
private void ValidateAutoRemove()
{
if (_autoRemoveJob && !_wait)
{
throw PSTraceSource.NewInvalidOperationException(RemotingErrorIdStrings.AutoRemoveCannotBeUsedWithoutWait);
}
}
private void ValidateForce()
{
if (Force && !_wait)
{
throw PSTraceSource.NewInvalidOperationException(RemotingErrorIdStrings.ForceCannotBeUsedWithoutWait);
}
}
private void ValidateWriteJobInResults()
{
if (_outputJobFirst && !_wait)
{
throw PSTraceSource.NewInvalidOperationException(RemotingErrorIdStrings.WriteJobInResultsCannotBeUsedWithoutWait);
}
}
#endregion Private Methods
#region OutputProcessingState
private void SetOutputProcessingState(bool processingOutput)
{
bool stateChanged;
lock (_syncObject)
{
stateChanged = (processingOutput != _processingOutput);
if (stateChanged)
{
_processingOutput = processingOutput;
}
}
if (_outputProcessingNotification != null && stateChanged)
{
_outputProcessingNotification.RaiseOutputProcessingStateChangedEvent(processingOutput);
}
}
#endregion
}
#region OutputProcessingState
internal class OutputProcessingState : IOutputProcessingState
{
public event EventHandler<OutputProcessingStateEventArgs> OutputProcessingStateChanged;
internal void RaiseOutputProcessingStateChangedEvent(bool processingOutput)
{
try
{
OutputProcessingStateChanged.SafeInvoke<OutputProcessingStateEventArgs>(
this,
new OutputProcessingStateEventArgs(processingOutput));
}
catch (Exception)
{
}
}
}
#endregion
}
|