pthread_attr_get_np(3) [freebsd man page]

PTHREAD_ATTR_GET_NP(3)					   BSD Library Functions Manual 				    PTHREAD_ATTR_GET_NP(3)

NAME

     pthread_attr_get_np -- get attributes of existent thread

LIBRARY

     POSIX Threads Library (libpthread, -lpthread)

SYNOPSIS

     #include <pthread_np.h>

     int
     pthread_attr_get_np(pthread_t pid, pthread_attr_t *dst);

DESCRIPTION

     The pthread_attr_get_np() function is used to get existent thread's attributes.  Most fields of pthread_attr_t structure are exact values of
     attributes provided at thread creation time (as parameter to pthread_create(3) function), except for the stack address.

     Value returned as dst is supposed to be used in conjunction with pthread_attr_get*() functions to retrieve individual values from
     pthread_attr_t structure.	Parameter dst should point to allocated memory area big enough to fit this structure.

     It is HIGHLY RECOMMENDED to use pthread_attr_init(3) function to allocate attribute storage.

IMPLEMENTATION NOTES

     The pthread_attr_get_np() function will always return a pointer to the thread's real stack address, regardless of its value in the original
     attributes structure.

RETURN VALUES

     If successful, pthread_attr_get_np() function returns 0.  Otherwise, an error number is returned to indicate the error.

EXAMPLES

     size_t
     my_thread_stack_size(pthread_t pid)
     {
	 pthread_attr_t attr;
	 size_t size;

	 pthread_attr_init(&attr);
	 pthread_attr_get_np(pid, &attr);
	 pthread_attr_getstacksize(&attr, &size);
	 pthread_attr_destroy(&attr);
	 return(size);
     }

ERRORS

     The pthread_attr_get_np() function will fail if:

     [EINVAL]		Invalid value for one of given parameters.

     [ESRC]		No thread could be found corresponding to that specified by the given thread ID.

SEE ALSO

     pthread_attr_destroy(3), pthread_attr_getdetachstate(3), pthread_attr_getinheritsched(3), pthread_attr_getschedparam(3),
     pthread_attr_getschedpolicy(3), pthread_attr_getscope(3), pthread_attr_getstack(3), pthread_attr_getstackaddr(3),
     pthread_attr_getstacksize(3), pthread_attr_init(3)

AUTHORS

     The pthread_attr_get_np() function and this manual page were written by Alexey Zelkin <phantom@FreeBSD.org>.

BSD
								 January 31, 2003							       BSD

PTHREAD_ATTR(3) 					   BSD Library Functions Manual 					   PTHREAD_ATTR(3)

NAME

     pthread_attr_init, pthread_attr_destroy, pthread_attr_setstack, pthread_attr_getstack, pthread_attr_setguardsize, pthread_attr_getguardsize
     -- thread attribute operations

SYNOPSIS

     #include <pthread.h>

     int
     pthread_attr_init(pthread_attr_t *attr);

     int
     pthread_attr_destroy(pthread_attr_t *attr);

     int
     pthread_attr_setstack(pthread_attr_t *attr, void *stackaddr, size_t stacksize);

     int
     pthread_attr_getstack(const pthread_attr_t * restrict attr, void ** restrict stackaddr, size_t * restrict stacksize);

     int
     pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);

     int
     pthread_attr_getstacksize(const pthread_attr_t *attr, size_t *stacksize);

     int
     pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize);

     int
     pthread_attr_getguardsize(const pthread_attr_t *attr, size_t *guardsize);

     int
     pthread_attr_setstackaddr(pthread_attr_t *attr, void *stackaddr);

     int
     pthread_attr_getstackaddr(const pthread_attr_t *attr, void **stackaddr);

     int
     pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);

     int
     pthread_attr_getdetachstate(const pthread_attr_t *attr, int *detachstate);

     int
     pthread_attr_setinheritsched(pthread_attr_t *attr, int inheritsched);

     int
     pthread_attr_getinheritsched(const pthread_attr_t *attr, int *inheritsched);

     int
     pthread_attr_setschedparam(pthread_attr_t *attr, const struct sched_param *param);

     int
     pthread_attr_getschedparam(const pthread_attr_t *attr, struct sched_param *param);

     int
     pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);

     int
     pthread_attr_getschedpolicy(const pthread_attr_t *attr, int *policy);

     int
     pthread_attr_setscope(pthread_attr_t *attr, int contentionscope);

     int
     pthread_attr_getscope(const pthread_attr_t *attr, int *contentionscope);

DESCRIPTION

     Thread attributes are used to specify parameters to pthread_create().  One attribute object can be used in multiple calls to
     pthread_create(), with or without modifications between calls.

     The pthread_attr_init() function initializes attr with all the default thread attributes.

     The pthread_attr_destroy() function destroys attr.

     The pthread_attr_set*() functions set the attribute that corresponds to each function name.

     The pthread_attr_get*() functions copy the value of the attribute that corresponds to each function name to the location pointed to by the
     second function parameter.

RETURN VALUES

     If successful, these functions return 0.  Otherwise, an error number is returned to indicate the error.

ERRORS

     The pthread_attr_init() function will fail if:

     [ENOMEM]		Out of memory.

     The pthread_attr_destroy() function will fail if:

     [EINVAL]		Invalid value for attr.

SEE ALSO

     pthread_attr_affinity_np(3), pthread_attr_get_np(3), pthread_create(3)

STANDARDS

     pthread_attr_init(), pthread_attr_destroy(), pthread_attr_setstacksize(), pthread_attr_getstacksize(), pthread_attr_setstackaddr(),
     pthread_attr_getstackaddr(), pthread_attr_setdetachstate(), and pthread_attr_getdetachstate() functions conform to ISO/IEC 9945-1:1996
     (``POSIX.1'')

     The pthread_attr_setinheritsched(), pthread_attr_getinheritsched(), pthread_attr_setschedparam(), pthread_attr_getschedparam(),
     pthread_attr_setschedpolicy(), pthread_attr_getschedpolicy(), pthread_attr_setscope(), and pthread_attr_getscope() functions conform to
     Version 2 of the Single UNIX Specification (``SUSv2'')

BSD
								  January 8, 2010							       BSD