[#BloombergLP-bslmt-ThreadAttributes]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslmt.adoc[bslmt]::ThreadAttributes
:relfileprefix: ../../
:mrdocs:

This simply constrained (value&hyphen;semantic) attribute class characterizes a collection of thread attribute values&period;

== Synopsis

Declared in `&lt;bslmt&lowbar;threadattributes&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ThreadAttributes;
----

== Description

See the  section for information on the class attributes&period;

This class&colon; &ast; supports a complete set of _value_ _semantic_ operations

* except for `bdex` serialization &ast; is _exception&hyphen;neutral_ &ast; is _alias&hyphen;safe_ &ast; is `const` _thread&hyphen;safe_ For terminology see `bsldoc&lowbar;glossary`&period;

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/ThreadAttributes/_04enum.adoc[`Unnamed enum`] 
| Default attribute value constants&period;
| xref:BloombergLP/bslmt/ThreadAttributes/DetachedState-09.adoc[`DetachedState`] 
| This enumeration provides two values used to distinguish among a joinable thread and a non&hyphen;joinable (detached) thread&period;
| xref:BloombergLP/bslmt/ThreadAttributes/SchedulingPolicy-08.adoc[`SchedulingPolicy`] 
| Thread scheduling policies&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/ThreadAttributes/2constructor-09.adoc[`ThreadAttributes`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslmt/ThreadAttributes/operator_assign.adoc[`operator&equals;`] 
| Assign to this object the value of the specified `rhs` object, and return a reference providing modifiable access to this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/allocator.adoc[`allocator`] 
| Return the allocator used by this object to supply memory&period;
| xref:BloombergLP/bslmt/ThreadAttributes/detachedState-05.adoc[`detachedState`] 
| Return the value of the `detachedState` attribute of this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/guardSize.adoc[`guardSize`] 
| Return the value of the `guardSize` attribute of this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/inheritSchedule.adoc[`inheritSchedule`] 
| Return the value of the `inheritSchedule` attribute of this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/print.adoc[`print`] 
| Format this object to the specified output `stream` and return a reference to `stream`&period;
| xref:BloombergLP/bslmt/ThreadAttributes/schedulingPolicy-01.adoc[`schedulingPolicy`] 
| Return the value of the `schedulingPolicy` attribute of this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/schedulingPriority.adoc[`schedulingPriority`] 
| Return the value of the `schedulingPriority` attribute of this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/setDetachedState.adoc[`setDetachedState`] 
| Set the `detachedState` attribute of this object to the specified `value`&period;
| xref:BloombergLP/bslmt/ThreadAttributes/setGuardSize.adoc[`setGuardSize`] 
| Set the `guardSize` attribute of this object to the specified `value` (in bytes)&period;
| xref:BloombergLP/bslmt/ThreadAttributes/setInheritSchedule.adoc[`setInheritSchedule`] 
| Set the `inheritSchedule` attribute of this object to the specified `value`&period;
| xref:BloombergLP/bslmt/ThreadAttributes/setSchedulingPolicy.adoc[`setSchedulingPolicy`] 
| Set the `schedulingPolicy` attribute of this object to the specified `value`&period;
| xref:BloombergLP/bslmt/ThreadAttributes/setSchedulingPriority.adoc[`setSchedulingPriority`] 
| Set the `schedulingPriority` attribute of this object to the specified `value`&period;
| xref:BloombergLP/bslmt/ThreadAttributes/setStackSize.adoc[`setStackSize`] 
| Set the `stackSize` attribute of this object to the specified `value`&period;
| xref:BloombergLP/bslmt/ThreadAttributes/setThreadName.adoc[`setThreadName`] 
| Set the `threadName` attribute of this object to the specified `value`&period; Return a non&hyphen;`const` reference to this object (see also &lcub;Fluent Interface&rcub;)&period;
| xref:BloombergLP/bslmt/ThreadAttributes/stackSize.adoc[`stackSize`] 
| Return the value of the `stackSize` attribute of this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/threadName.adoc[`threadName`] 
| Return the `threadName` attribute of this object&period;
| xref:BloombergLP/bslmt/ThreadAttributes/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration&lt;ThreadAttributes, UsesBslmaAllocator&gt;`] 
| Declare that this type uses a `bslma` allocator&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/operator_not_eq.adoc[`operator!&equals;`]
| Return `true` if the specified `lhs` and `rhs` objects do not have the same value, and `false` otherwise&period;
| xref:BloombergLP/bslmt/operator_eq.adoc[`operator&equals;&equals;`]
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
