dotnet-api-docs/xml/System.Net/SocketPermission.xml at main · dotnet/dotnet-api-docs

History

679 lines (649 loc) · 42 KB

Raw

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

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

</TypeForwardingChain>

<Base>

<BaseTypeName>System.Security.CodeAccessPermission</BaseTypeName>

</Base>

<InterfaceName>System.Security.Permissions.IUnrestrictedPermission</InterfaceName>

</Interface>

</Interfaces>

<AttributeName Language="C#">[System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Serializable]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Controls rights to make or accept connections on a transport address.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

[!INCLUDE[cas-deprecated](~/includes/cas-deprecated.md)]

<xref:System.Net.SocketPermission> instances control permission to accept connections or initiate <xref:System.Net.Sockets.Socket> connections. A <xref:System.Net.Sockets.Socket> permission can be established for a host name or IP address, a port number, and a transport protocol.

> [!NOTE]

> Avoid creating socket permissions using host names, as these names have to be resolved to IP addresses, and this might block the stack.

]]></format>

</remarks>

</Docs>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Net.SocketPermission" /> class.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="new System.Net.SocketPermission : System.Security.Permissions.PermissionState -> System.Net.SocketPermission" Usage="new System.Net.SocketPermission state" />

<MemberType>Constructor</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="state">One of the <see cref="T:System.Security.Permissions.PermissionState" /> values.</param>

<summary>Initializes a new instance of the <see cref="T:System.Net.SocketPermission" /> class that allows unrestricted access to the <see cref="T:System.Net.Sockets.Socket" /> or disallows access to the <see cref="T:System.Net.Sockets.Socket" />.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

If the <xref:System.Net.SocketPermission> instance is created with the `Unrestricted` value from <xref:System.Security.Permissions.PermissionState> then the <xref:System.Net.SocketPermission> instance passes all demands. Any other value for `state` results in a <xref:System.Net.SocketPermission> instance that fails all demands unless a transport address permission is added with <xref:System.Net.SocketPermission.AddPermission%2A>.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Net.SocketPermission : System.Net.NetworkAccess * System.Net.TransportType * string * int -> System.Net.SocketPermission" Usage="new System.Net.SocketPermission (access, transport, hostName, portNumber)" />

<MemberType>Constructor</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

</Parameters>

<Docs>

<param name="access">One of the <see cref="T:System.Net.NetworkAccess" /> values.</param>

<param name="transport">One of the <see cref="T:System.Net.TransportType" /> values.</param>

<param name="hostName">The host name for the transport address.</param>

<param name="portNumber">The port number for the transport address.</param>

<summary>Initializes a new instance of the <see cref="T:System.Net.SocketPermission" /> class for the given transport address with the specified permission.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This constructor creates a <xref:System.Net.SocketPermission> that controls access to the specified `hostName` and `portNumber` using the specified `transport`.

The `hostName` can be a DNS name, an IP address, or a specified IP subnet, such as 192.168.1.*.

The `portNumber` can be any valid port number defined by the transport, or <xref:System.Net.SocketPermission.AllPorts?displayProperty=nameWithType>.

]]></format>

</remarks>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Collections.IEnumerator</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets a list of <see cref="T:System.Net.EndpointPermission" /> instances that identifies the endpoints that can be accepted under this permission instance.</summary>

<value>An instance that implements the <see cref="T:System.Collections.IEnumerator" /> interface that contains <see cref="T:System.Net.EndpointPermission" /> instances.</value>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="member this.AddPermission : System.Net.NetworkAccess * System.Net.TransportType * string * int -> unit" Usage="socketPermission.AddPermission (access, transport, hostName, portNumber)" />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="access">One of the <see cref="T:System.Net.NetworkAccess" /> values.</param>

<param name="transport">One of the <see cref="T:System.Net.TransportType" /> values.</param>

<param name="hostName">The host name for the transport address.</param>

<param name="portNumber">The port number for the transport address.</param>

<summary>Adds a permission to the set of permissions for a transport address.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

The `hostName` can be a DNS name, an IP address, or a specified IP subnet, such as 192.168.1.*.

]]></format>

</remarks>

</Docs>

</Member>

<MemberType>Field</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Int32</ReturnType>

</ReturnValue>

<Docs>

<summary>Defines a constant that represents all ports.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This field is read-only. The value of this field is -1.

]]></format>

</remarks>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Collections.IEnumerator</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets a list of <see cref="T:System.Net.EndpointPermission" /> instances that identifies the endpoints that can be connected to under this permission instance.</summary>

<value>An instance that implements the <see cref="T:System.Collections.IEnumerator" /> interface that contains <see cref="T:System.Net.EndpointPermission" /> instances.</value>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.Copy : unit -> System.Security.IPermission" Usage="socketPermission.Copy " />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Security.IPermission</ReturnType>

</ReturnValue>

<Docs>

<summary>Creates a copy of a <see cref="T:System.Net.SocketPermission" /> instance.</summary>

<returns>A new instance of the <see cref="T:System.Net.SocketPermission" /> class that is a copy of the current instance.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The object returned by this method represents the same level of access as the current instance. This method overrides <xref:System.Security.CodeAccessPermission.Copy%2A> and is implemented to support the <xref:System.Security.IPermission> interface.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.FromXml : System.Security.SecurityElement -> unit" Usage="socketPermission.FromXml securityElement" />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Void</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="securityElement">The XML encoding used to reconstruct the <see cref="T:System.Net.SocketPermission" /> instance.</param>

<summary>Reconstructs a <see cref="T:System.Net.SocketPermission" /> instance for an XML encoding.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.SocketPermission.FromXml%2A> method reconstructs a <xref:System.Net.SocketPermission> instance from an XML encoding defined by the <xref:System.Security.SecurityElement> class.

Use the <xref:System.Net.SocketPermission.ToXml%2A> method to encode the <xref:System.Net.SocketPermission> instance, including state information, in XML.

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">The <paramref name="securityElement" /> is not a permission element for this type.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.Intersect : System.Security.IPermission -> System.Security.IPermission" Usage="socketPermission.Intersect target" />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Security.IPermission</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="target">The <see cref="T:System.Net.SocketPermission" /> instance to intersect with the current instance.</param>

<summary>Returns the logical intersection between two <see cref="T:System.Net.SocketPermission" /> instances.</summary>

<returns>The <see cref="T:System.Net.SocketPermission" /> instance that represents the intersection of two <see cref="T:System.Net.SocketPermission" /> instances. If the intersection is empty, the method returns <see langword="null" />. If the <paramref name="target" /> parameter is a null reference, the method returns <see langword="null" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The intersection of two permissions is a permission that helps to protect the resources and operations protected by both permissions. Specifically, it represents the minimum permission such that any demand that passes both permissions also passes their intersection. This method overrides <xref:System.Security.CodeAccessPermission.Intersect%2A> and is implemented to support the <xref:System.Security.IPermission> interface.

]]></format>

</remarks>

<exception cref="T:System.ArgumentException">The <paramref name="target" /> parameter is not a <see cref="T:System.Net.SocketPermission" />.</exception>

<see cref="T:System.Net.DnsPermission" /> is not granted to the method caller.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.IsSubsetOf : System.Security.IPermission -> bool" Usage="socketPermission.IsSubsetOf target" />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="target">A <see cref="T:System.Net.SocketPermission" /> that is to be tested for the subset relationship.</param>

<summary>Determines if the current permission is a subset of the specified permission.</summary>

<returns>If <paramref name="target" /> is <see langword="null" />, this method returns <see langword="true" /> if the current instance defines no permissions; otherwise, <see langword="false" />. If <paramref name="target" /> is not <see langword="null" />, this method returns <see langword="true" /> if the current instance defines a subset of <paramref name="target" /> permissions; otherwise, <see langword="false" />.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The current permission is a subset of the specified permission if the current permission specifies a set of operations that is wholly contained by the specified permission.

For example, a permission that represents access to 192.168.1.1:80 is a subset of a permission that represents access to 192.168.1.1:Any. If this method returns `true`, the current permission represents no more access to the protected resource than does the specified permission.

]]></format>

</remarks>

<see cref="T:System.Net.DnsPermission" /> is not granted to the method caller.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member IsUnrestricted : unit -> bool
override this.IsUnrestricted : unit -> bool" Usage="socketPermission.IsUnrestricted " />

<MemberType>Method</MemberType>

<InterfaceMember>M:System.Security.Permissions.IUnrestrictedPermission.IsUnrestricted</InterfaceMember>

</Implements>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Boolean</ReturnType>

</ReturnValue>

<Docs>

<summary>Checks the overall permission state of the object.</summary>

<see langword="true" /> if the <see cref="T:System.Net.SocketPermission" /> instance is created with the <see langword="Unrestricted" /> value from <see cref="T:System.Security.Permissions.PermissionState" />; otherwise, <see langword="false" />.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.ToXml : unit -> System.Security.SecurityElement" Usage="socketPermission.ToXml " />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Security.SecurityElement</ReturnType>

</ReturnValue>

<Docs>

<summary>Creates an XML encoding of a <see cref="T:System.Net.SocketPermission" /> instance and its current state.</summary>

<returns>A <see cref="T:System.Security.SecurityElement" /> instance that contains an XML-encoded representation of the <see cref="T:System.Net.SocketPermission" /> instance, including state information.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Net.SocketPermission.ToXml%2A> method creates a <xref:System.Security.SecurityElement> instance to encode a representation of the <xref:System.Net.SocketPermission> instance, including state information, in XML.

Use the <xref:System.Net.SocketPermission.FromXml%2A> method to restore the state information from a <xref:System.Security.SecurityElement> instance.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="override this.Union : System.Security.IPermission -> System.Security.IPermission" Usage="socketPermission.Union target" />

<MemberType>Method</MemberType>

<AssemblyName>System</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Security.Permissions</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Security.IPermission</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="target">The <see cref="T:System.Net.SocketPermission" /> instance to combine with the current instance.</param>

<summary>Returns the logical union between two <see cref="T:System.Net.SocketPermission" /> instances.</summary>

<returns>The <see cref="T:System.Net.SocketPermission" /> instance that represents the union of two <see cref="T:System.Net.SocketPermission" /> instances. If <paramref name="target" /> parameter is <see langword="null" />, it returns a copy of the current instance.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The result of a call to <xref:System.Net.SocketPermission.Union%2A> is a permission that represents all of the access to <xref:System.Net.Sockets.Socket> connections represented by the current instance as well as the access represented by `target`. Any demand that passes either the current instance or `target` passes their union. This method overrides <xref:System.Security.CodeAccessPermission.Union%2A> and is implemented to support the <xref:System.Security.IPermission> interface.

]]></format>

</remarks>

</Docs>

</Member>

</Members>

</Type>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

SocketPermission.xml

Latest commit

History

SocketPermission.xml

File metadata and controls